docs: wind-style relative links + marketing-first README#93
Merged
Conversation
- Convert the 11 site-absolute doc links (/section/page) to repo-relative .md paths (./page.md, ../section/page.md), matching wind's convention. The docs site rewrites these to its own routed URLs on sync. - Rewrite README marketing-first like wind: minimal two-command install (flutter pub add magic + dart run magic:artisan magic:install), lead with Why/Features/taste, delegate the full reference to the docs. - docs-link-check: drop --root-dir/--fallback-extensions (no longer any site-absolute links) and promote --include-fragments into the per-PR offline gate so cross-page #anchors are validated at PR time.
There was a problem hiding this comment.
Pull request overview
This PR standardizes documentation linking to Wind’s repo-relative .md convention, refactors the top-level README into a shorter marketing-first shape, and updates the docs link-check workflow to validate cross-page fragments during PRs without relying on --root-dir / --fallback-extensions.
Changes:
- Convert remaining docs site-absolute links (e.g.,
/section/page) to repo-relative.mdlinks across the touched docs pages. - Restructure
README.mdinto a shorter install/why/features/example format, and update feature counts/sections accordingly. - Update
.github/workflows/docs-link-check.ymlto drop doc-root resolution flags and to validate#fragmentsin the per-PR offline gate.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Rewrites README into a shorter marketing-first layout; updates install snippet, features table, and doc pointers. |
| doc/security/encryption.md | Switches Vault link to repo-relative ./vault.md. |
| doc/getting-started/installation.md | Switches multiple “next steps” and CLI links to repo-relative .md paths (including #install fragment). |
| doc/digging-deeper/file-picker.md | Updates Magic Storage link to ./file-storage.md. |
| doc/basics/routing.md | Updates Middleware and Database doc links to repo-relative .md paths. |
| doc/basics/middleware.md | Updates Authorization doc link to repo-relative ../security/authorization.md. |
| .github/workflows/docs-link-check.yml | Removes reliance on doc-root/fallback extension flags and enables fragment validation in the PR offline link check. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Follow-up polish on top of #92.
What
.mdpaths everywhere. Converted the 11 site-absolute links (/section/page) across 5 pages to relative.md(./page.md,../section/page.md). The docs site rewrites these to its own routed URLs on sync, same as wind.--root-dir doc/--fallback-extensions md(no more site-absolute links), and promoted--include-fragmentsinto the per-PR offline gate so cross-page#anchors(magic's<a name>style) are validated at PR time, not just weekly.Verification
#installlink has a path before#, so it is not treated as a local anchor).