Repository navigation
Docs | Add an anatomy of craft and split out developer docs - #6
Merged
Merged
Conversation
Lets docs pages draw diagrams from mermaid code blocks.
Resolved by craft add, so craft ci in the docs workflow matches package.json.
Mermaid loads lazily, only on pages that have a diagram, and redraws in the site's colours whenever the theme switches between light and dark.
Makes MermaidDiagram available to every markdown page.
Contributor pages now live under /developers/, apart from the guide for people using craft.
Contributor pages now live under /developers/, apart from the guide for people using craft.
Contributor pages now live under /developers/, apart from the guide for people using craft.
Walks through the CLI, the manager, actors and pipes, an install end to end, resolution, metadata, the store and concurrency, with diagrams, to explain why craft is fast and where it is still slow.
Turns mermaid code blocks into diagrams, and replaces the Contributing nav with Developers, whose sidebar holds Anatomy and Architecture next to the contributing pages.
Readers who want the internals behind the layout can follow on to the developer docs.
The contributing pages moved to /developers/.
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.
What
/developers/) holds Anatomy, Architecture, Getting set up and Testing.Reviewer notes
/contributing/*URLs are gone (moved to/developers/*); VitePress has no redirects, so outside links to them will 404. The README link is updated.