Skip to content

Conversation

@crandmck
Copy link
Contributor

@crandmck crandmck commented Nov 4, 2025

This PR contains some improvements to the Jekyll site generation that we can leverage when we fully automate the API doc generation and ultimately remove the TypeDoc-generated .md files from the repo. This is a step in that direction.

  • Changes the build:docs command in package.json so that building docs won't delete or overwrite the files used for the Jekyll/GHP site. It should only generate/update .md files in docs/classes, docs/functions, docs/interfaces, and docs/type-aliases.
  • Replaces manually-written list of pages with programmatic list of links to the files in docs/classes, docs/functions, docs/interfaces, and docs/type-aliases
  • Adds an docs/index.md which is the API doc landing page. README.md is used for the sidebar content.
  • Ensures that the nav items displayed in the top right contain only the links to Classes, Functions, etc.

@crandmck crandmck requested review from cdmurph32 and emensch November 4, 2025 18:41
@crandmck crandmck changed the title Some clean up to Jekyll site docs: Some clean up to Jekyll site Nov 6, 2025
@crandmck crandmck merged commit ebce60d into main Nov 7, 2025
3 of 5 checks passed
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