Skip to content

Initialize New Docs Website Skeleton#2

Open
danchild wants to merge 1 commit into
gophercloud:developmentfrom
shiftstack:feat/astro-project-skeleton
Open

Initialize New Docs Website Skeleton#2
danchild wants to merge 1 commit into
gophercloud:developmentfrom
shiftstack:feat/astro-project-skeleton

Conversation

@danchild

@danchild danchild commented Jun 10, 2026

Copy link
Copy Markdown

Proposal: gophercloud.io documentation overhaul

Today, the authoritative pkg.go.dev api reference and the source
repository are the only vehicles to learn more about gophercloud.
Fresh, discoverable, user-friendly documentation is desired to
improve the gophercloud developer experience and drive community
engagement. Therefore, I propose a new gohpercloud.io docs website
using the following stack:

  • Astro: a popular web framework for content-driven webites supporting reactive, fully-static builds using github pages.
  • Starlight: a documentation library for astro.
  • Typescript (minimal surface as most of the content is expressed as markdown.
    Reactivity is accomplished through mdx files.
  • Tailwindcss: styling provided by a modern, declarative syntax powered by rust.
  • pnpm: modern package manager powered by rust.

The following artifacts serve as a project entry point for the new documentation
website, utilizing Astro's default project skeleton.

Choices include:
- typescript
- starlight   (documentation framework)
- tailwindcss (styling)

Signed-off-by: Dan Childers <dchilder@redhat.com>
@danchild danchild marked this pull request as ready for review June 10, 2026 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant