docs: migrate the documentation site to Fumadocs - #137
Draft
leoafarias wants to merge 41 commits into
Draft
Conversation
This file contains hidden or 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
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.
Summary
docs/as the canonical content directory so existing Dart documentation tests continue to read the same filesmeta.json/ackbase path used byhttps://concepta.dev/ackArchitecture
The application lives in
docs-site/. Ack still owns its content, routes, source loader, search endpoint, and deployment settings.docs-site/packages/docs-themeis a pinned workspace snapshot of@conceptadev/docs-themefromconceptadev/docs-theme#2. This is necessary because the shared package is not yet published and its repository is internal while Ack is public. Once the package is released, this snapshot can be removed without changing the application API.Included behavior
/api/search/llms.txt,/llms-full.txt, and per-page Markdown outputValidation
The Documentation workflow now runs:
DOCS_BASE_PATH=/ackThe repository-wide workflow security tests continue to require immutable action SHAs, a pinned runner, and pinned npm packages.
Hosting cutover required before merge
This PR removes
docs.json, which ends docs.page ownership of the site. Before merging, configurehttps://concepta.dev/ackto serve the generated contents ofdocs-site/outat the/ackpath. The exact build and cutover contract is documented indocs-site/DEPLOYMENT.md.Supersedes
This adopts the Concepta Fumadocs foundation proposed in
conceptadev/docs-theme#2for Ack's complete existing documentation set.