Skip to content

docs: link core-owned reference pages via docs.specfact.io#140

Merged
djm81 merged 4 commits intodevfrom
chore/docs-link-core-handoff-urls
Apr 2, 2026
Merged

docs: link core-owned reference pages via docs.specfact.io#140
djm81 merged 4 commits intodevfrom
chore/docs-link-core-handoff-urls

Conversation

@djm81
Copy link
Copy Markdown
Contributor

@djm81 djm81 commented Apr 2, 2026

Summary

Fixes broken internal markdown links flagged by test_authored_internal_docs_links_resolve_to_published_docs_targets (relative paths to debug-logging.md, directory-structure.md, and feature-keys.md that do not exist in this repo).

Those topics live under core CLI docs. Links now use canonical https://docs.specfact.io/... URLs per docs/reference/documentation-url-contract.md.

Files

  • docs/reference/README.md — reference index
  • docs/reference/architecture.md, docs/reference/schema-versioning.md
  • docs/guides/agile-scrum-workflows.md
  • docs/adapters/azuredevops.md (debug logging anchor for ADO errors)

Validation

  • pytest tests/unit/docs/test_docs_review.py::test_authored_internal_docs_links_resolve_to_published_docs_targets (no pre-existing link warning).

Made with Cursor

Replace relative links to missing local stubs (debug-logging,
directory-structure, feature-keys) with canonical core CLI URLs per
the modules/core documentation URL contract.

Made-with: Cursor
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 2, 2026

Warning

Rate limit exceeded

@djm81 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 45 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 11 minutes and 45 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: ad101e4e-108f-4f51-b36b-d7d7f08db94e

📥 Commits

Reviewing files that changed from the base of the PR and between e6f2cf7 and 0cad580.

📒 Files selected for processing (7)
  • docs/adapters/azuredevops.md
  • docs/guides/agile-scrum-workflows.md
  • docs/reference/README.md
  • docs/reference/architecture.md
  • docs/reference/schema-versioning.md
  • scripts/check-docs-commands.py
  • tests/unit/test_check_docs_commands_script.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/docs-link-core-handoff-urls

Comment @coderabbitai help to get the list of available commands and usage tips.

@djm81 djm81 self-assigned this Apr 2, 2026
@djm81 djm81 added the documentation Improvements or additions to documentation label Apr 2, 2026
@djm81 djm81 moved this from Todo to In Progress in SpecFact CLI Apr 2, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 524463c1ce

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

djm81 and others added 3 commits April 3, 2026 00:10
Docs Review failed on PR #140: links to core docs.specfact.io pages for
debug-logging, directory-structure, and feature-keys. Extend
ALLOWED_CORE_DOCS_ROUTES to match published specfact-cli permalinks.

Made-with: Cursor
Assert debug-logging (with fragment), directory-structure, and feature-keys
URLs produce no cross-site-link findings.

Made-with: Cursor
@djm81 djm81 added the enhancement New feature or request label Apr 2, 2026
@djm81 djm81 merged commit b48ae35 into dev Apr 2, 2026
10 checks passed
@github-project-automation github-project-automation bot moved this from In Progress to Done in SpecFact CLI Apr 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

OpenSpec: Peer bundle dependencies for code-review (module-bundle-deps-auto-install)

1 participant