Skip to content

Initialize New Docs Website Skeleton#2

Closed
danchild wants to merge 2 commits into
gophercloud:developmentfrom
shiftstack:feat/astro-project-skeleton
Closed

Initialize New Docs Website Skeleton#2
danchild wants to merge 2 commits 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

@stephenfin stephenfin left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've broadly the same comments here as in #3

@danchild

danchild commented Jun 26, 2026

Copy link
Copy Markdown
Author

Thanks for the review @stephenfin. I dropped the stock Astro/Starlight logos. See #3 for CNAME configuration differences with builds triggered by GitHub Actions.

Replace with .gitkeep files to retain folder convention

Signed-off-by: Dan Childers <dan@staat.dev>
@danchild danchild force-pushed the feat/astro-project-skeleton branch from 96d2c39 to 2294c3b Compare June 26, 2026 12:52
@danchild

Copy link
Copy Markdown
Author

Close to combine with #3

@danchild danchild closed this Jun 26, 2026
@danchild danchild deleted the feat/astro-project-skeleton branch June 26, 2026 15:22
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.

2 participants