Skip to content
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.

Sign up for GitHub

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

Jump to bottom

link checking should include [ref page](ref:slug) syntax in addition to [guide page](doc:slug) link syntax #38

Open
fscelliott opened this issue Jul 31, 2023 · 1 comment
Open

link checking should include [ref page](ref:slug) syntax in addition to [guide page](doc:slug) link syntax #38

fscelliott opened this issue Jul 31, 2023 · 1 comment

Comments

@fscelliott
Copy link
Contributor

this sync tool should enforce fixing links from the guides to the API reference that have the internal link ref page syntax, but seems to miss them? I tested by inserting [test ref](ref:test-me-broken)](ref:test-me-broken) and the tool synced successfully. It fails if I insert [test doc](doc:broken-link)](doc:broken-link).

tested in this commit https://github.com/sensible-hq/sensible-docs/actions/runs/5719311414/job/15496934038
@fscelliott
Copy link
Contributor Author

fscelliott commented Aug 2, 2023 •
edited
Loading

I haven't checked, but if the sync tool doesn't enforce link validation for (changelog page)[changelog:slug] type syntax it should as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@fscelliott