search

seamapi / docs

Welcome to the Seam Docs.
https://docs.seam.co
4 stars 10 forks source link

Only generate relative links to files that exist #320

Closed razor-x closed 2 weeks ago

razor-x commented 2 weeks ago

If the link does not point to an actual .md file, GitBook will generate a link back to github (even if the files does not exist there). This will check the .md files exists before creating the link, otherwise it just prints a warning and keeps the absolute link.

This PR also updates some links from the old api-clients/acs/systems/*.md to the new api/acs/systems/*.md

razor-x commented 2 weeks ago

Current links with issues:

Could not find a matching file for https://docs.seam.co/latest/capability-guides/access-systems at docs/capability-guides/access-systems.md or docs/capability-guides/access-systems/README.md.
Could not find a matching file for https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group at docs/capability-guides/access-systems/assigning-users-to-access-groups.md or docs/capability-guides/access-systems/assigning-users-to-access-groups/README.md.
Could not find a matching file for https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut at docs/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system.md or docs/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system/README.md.
Could not find a matching file for https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups at docs/capability-guides/access-systems/assigning-users-to-access-groups.md or docs/capability-guides/access-systems/assigning-users-to-access-groups/README.md.
Could not find a matching file for https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group at docs/capability-guides/access-systems/assigning-users-to-access-groups.md or docs/capability-guides/access-systems/assigning-users-to-access-groups/README.md.
Could not find a matching file for https://docs.seam.co/latest/capability-guides/access-systems at docs/capability-guides/access-systems.md or docs/capability-guides/access-systems/README.md.
Could not find a matching file for https://docs.seam.co/latest/capability-guides/access-systems at docs/capability-guides/access-systems.md or docs/capability-guides/access-systems/README.md.
Could not find a matching file for https://docs.seam.co/latest/capability-guides/access-systems at docs/capability-guides/access-systems.md or docs/capability-guides/access-systems/README.md.
Could not find a matching file for https://docs.seam.co/latest/capability-guides/access-systems at docs/capability-guides/access-systems.md or docs/capability-guides/access-systems/README.md.
Could not find a matching file for https://docs.seam.co/latest/capability-guides/access-systems at docs/capability-guides/access-systems.md or docs/capability-guides/access-systems/README.md.
Could not find a matching file for https://docs.seam.co/latest/capability-guides/access-systems at docs/capability-guides/access-systems.md or docs/capability-guides/access-systems/README.md.
razor-x commented 2 weeks ago

@DebbieAtSeam and @andrii-balitskyi to I'm going to merge this to beta so we can review the main PR here: https://github.com/seamapi/docs/pull/316

But please leave a review post merge if you notice something / have feedback.