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

feat: Documentation Site #163

Draft
wants to merge 28 commits into
base: main
Choose a base branch
from
Draft

feat: Documentation Site #163

wants to merge 28 commits into from

Conversation

orteth01
Copy link
Contributor

✅ Pull Request Checklist:

  • Included link to corresponding GitHub Issue.
  • The commit message follows conventional commit extended guidelines.
  • Added/updated unit tests and storybook for this change (for bug fixes / features).
  • Added/updated documentation (for bug fixes / features)
  • Filled out test instructions.

📝 Test Instructions:

Proof of concept docs site using docusaurus and typedoc

i recorded a demo video that is too big to share here. dm me if you'd like to see it.

To run

probably good to do a clean/install/build

  • pnpm run clean
  • pnpm install
  • pnpm build

dev mode:

  • pnpm --filter=@accelint/docs dev

Note

search will not work in dev mode. the search index is built at build time.
to test search, build and serve:

  • pnpm --filter=@accelint/docs build
  • pnpm --filter=@accelint/docs serve

❓ Does this PR introduce a breaking change?

  • Yes
  • No

💬 Other information

deploy/release strategy for the docs still needs to be hashed out, so that is not in scope for this PR

@kalisjoshua kalisjoshua force-pushed the integration/docs-site branch from 5bc986e to 4ac7fc6 Compare January 14, 2025 18:40
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