-
Notifications
You must be signed in to change notification settings - Fork 1
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
orteth01
wants to merge
28
commits into
main
Choose a base branch
from
integration/docs-site
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Information architecture work
5bc986e
to
4ac7fc6
Compare
colors alignment and theme from hypergiant.com
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✅ Pull Request Checklist:
📝 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?
💬 Other information
deploy/release strategy for the docs still needs to be hashed out, so that is not in scope for this PR