Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP - feat: Add Docusaurus rewrite of docs site #3759

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

yhakbar
Copy link
Collaborator

@yhakbar yhakbar commented Jan 13, 2025

Description

So far, this is just a bare minimum Docusaurus server so that we can start prototyping.

We'll also be exploring Starlight, as it's another common documentation tool.

The end goal of this experimentation is to have another docs site hosted concurrently with the existing Jekyl based one that users can opt-in to. After the new docs site is live for a while, and users are happy with it, we'll swap out the default so that users navigate to the rewrite by default.

TODOs

Read the Gruntwork contribution guidelines.

  • Update the docs.
  • Run the relevant tests successfully, including pre-commit checks.
  • Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable.
  • Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Added / Removed / Updated [X].

Migration Guide

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