Skip to content

Condition documentation links on docs-as-code usage - #89

Merged
AlexanderLanin merged 2 commits into
mainfrom
copilot/update-documentation-link-conditionally
Aug 11, 2026
Merged

Condition documentation links on docs-as-code usage#89
AlexanderLanin merged 2 commits into
mainfrom
copilot/update-documentation-link-conditionally

Conversation

Copilot AI commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

Documentation links were shown for every repository, including repositories without GitHub Pages. They now appear only when the repository declares the docs-as-code Bazel module.

  • Rendering

    • Gate index and detail-page documentation links on score_docs_as_code.
    • Preserve GitHub and Bazel links for all repositories.
  • Coverage

    • Verify documented repositories include the Pages URL.
    • Verify repositories without docs-as-code omit it.
uses_docs_as_code = any(
    module_name == "score_docs_as_code"
    for module_name, _ in entry.content.bazel_deps
)

Copilot AI and others added 2 commits August 10, 2026 17:32
Co-authored-by: AlexanderLanin <5074553+AlexanderLanin@users.noreply.github.com>
Co-authored-by: AlexanderLanin <5074553+AlexanderLanin@users.noreply.github.com>
@AlexanderLanin
AlexanderLanin marked this pull request as ready for review August 10, 2026 17:36
@AlexanderLanin
AlexanderLanin requested a balanced review from Copilot August 10, 2026 17:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Conditions documentation links on the score_docs_as_code Bazel dependency.

Changes:

  • Adds a shared docs-as-code detection helper.
  • Gates index and detail documentation links.
  • Tests documented and plain repositories.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
src/generate_repo_overview/_html_common.py Adds detection and index-link gating.
src/generate_repo_overview/_html_detail.py Gates detail-page documentation links.
tests/test_cli_render.py Verifies links are included or omitted appropriately.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread src/generate_repo_overview/_html_common.py

@a-zw a-zw left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yes, makes sense.

@AlexanderLanin
AlexanderLanin merged commit 9a6d358 into main Aug 11, 2026
6 checks passed
@AlexanderLanin
AlexanderLanin deleted the copilot/update-documentation-link-conditionally branch August 11, 2026 06:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants