Skip to content

[Docs] - conform docs#3

Open
andrewfulton9 wants to merge 4 commits into
nebari-dev:mainfrom
andrewfulton9:docs/conform_docs
Open

[Docs] - conform docs#3
andrewfulton9 wants to merge 4 commits into
nebari-dev:mainfrom
andrewfulton9:docs/conform_docs

Conversation

@andrewfulton9

@andrewfulton9 andrewfulton9 commented Jun 19, 2026

Copy link
Copy Markdown

Reference Issues or PRs

closes #2

What does this implement/fix?

implements docs with the docusaurus engine with typescript and npm. Brings these docs up to standard with the rest of the core packs.

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

@andrewfulton9 andrewfulton9 requested a review from dcmcand as a code owner June 19, 2026 19:39
@andrewfulton9

Copy link
Copy Markdown
Author

For now I just linked the existing docs pages to the introduction. I figured the organization/reimplimentation of the docs can be done in a future PR as this is just intended to bring these docs up to date with the other placeholder docs

@killua156 killua156 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.

LGTM — TS Docusaurus docs site, CI green (the failing e2e-standalone check is an unrelated Helm cluster timeout).

@andrewfulton9 andrewfulton9 marked this pull request as draft June 29, 2026 17:51
@andrewfulton9

Copy link
Copy Markdown
Author

Docs serving engine must be converted to astro

@andrewfulton9 andrewfulton9 changed the title conform docs [Draft] - conform docs Jun 29, 2026
@andrewfulton9 andrewfulton9 changed the title [Draft] - conform docs [Docs] - conform docs Jul 6, 2026
@andrewfulton9 andrewfulton9 marked this pull request as ready for review July 6, 2026 15:43
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.

[DOC] - Conform docs to other packs

2 participants