Summary
A relative doc link resolves fine inside the repo (so CI's link checker passes) but is broken on the published documentation site, which only publishes the docs/ directory.
Details
docs/index.md:74: - [Reference applications](../examples/) for complete consumer patterns. uses a repo-relative path resolving to the top-level examples/ directory.
scripts/validate_docs.py only checks that the link target exists somewhere in the repository (validate_links() resolves relative to the repo root and just checks candidate.exists()), so this passes CI.
- Per
docs/releasing.md, mkdocs build --strict publishes only the docs/ directory to site_url: https://basefoundry.github.io/base-cli/, so ../examples/ has no corresponding path on the deployed site.
- Every other doc file that needs to reference
examples/ correctly uses a full GitHub URL instead (e.g. docs/adopter-readiness.md uses https://github.com/basefoundry/base-cli/blob/main/examples/README.md), confirming this is an isolated oversight in index.md.
Impact
A new user following the published docs site's landing page hits a dead link on the very first "reference applications" pointer.
Suggested fix
Replace with https://github.com/basefoundry/base-cli/tree/main/examples (or a full-URL link to examples/README.md), matching the pattern used elsewhere in docs/.
Summary
A relative doc link resolves fine inside the repo (so CI's link checker passes) but is broken on the published documentation site, which only publishes the
docs/directory.Details
docs/index.md:74:- [Reference applications](../examples/) for complete consumer patterns.uses a repo-relative path resolving to the top-levelexamples/directory.scripts/validate_docs.pyonly checks that the link target exists somewhere in the repository (validate_links()resolves relative to the repo root and just checkscandidate.exists()), so this passes CI.docs/releasing.md,mkdocs build --strictpublishes only thedocs/directory tosite_url: https://basefoundry.github.io/base-cli/, so../examples/has no corresponding path on the deployed site.examples/correctly uses a full GitHub URL instead (e.g.docs/adopter-readiness.mduseshttps://github.com/basefoundry/base-cli/blob/main/examples/README.md), confirming this is an isolated oversight inindex.md.Impact
A new user following the published docs site's landing page hits a dead link on the very first "reference applications" pointer.
Suggested fix
Replace with
https://github.com/basefoundry/base-cli/tree/main/examples(or a full-URL link toexamples/README.md), matching the pattern used elsewhere indocs/.