Repository navigation
chore: move the README's guides into a Pages docs site - #32
Merged
Merged
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.
The README had grown into the whole manual. Its sections now live as pages in
docs/, which a Pages workflow publishes with Jekyll to https://githubnext.github.io/desktop-tools/. The README keeps a short summary and links.docs/: index, app (now with DMG install from the v0.1.0 release), mcp, node, embed, build, licenses. Content is moved unchanged apart from the cross-links between pages..github/workflows/pages.yml: buildsdocs/withactions/jekyll-build-pagesand deploys on pushes to main that touchdocs/. Actions are pinned by SHA like the other workflows.Relative
.mdlinks work both on github.com and on the site (jekyll-relative-links).