Skip to content

Add /projects/ documentation index for CoMPhy Pages (Fixes #40) - #115

Merged
VatsalSy merged 5 commits into
mainfrom
rayleigh-cloud/project-docs-index-25f0
Sep 20, 2026
Merged

VatsalSy merged 5 commits into
mainfrom
rayleigh-cloud/project-docs-index-25f0

Conversation

@VatsalSy

@VatsalSy VatsalSy commented Sep 20, 2026

Copy link
Copy Markdown
Member

Fixes #40

Summary

Adds a public Project docs index at /projects/ that catalogues live CoMPhy Lab documentation sites hosted at https://comphy-lab.org/{Repo-Name}/ (GitHub Pages for comphy-lab/* repos). This is an in-site catalogue, not a wiki engine.

Path chosen

/projects/ — free on the site, sits next to Research in the IA, and matches “project documentation sites” better than /wiki/ or /docs/.

What changed

  • _data/project-docs.yml — maintainable inventory (24 live sites verified HTTP 200 on 2026-09-20; excluded comphy-lab.github.io and Pages repos that 404: energy-budget-issues, When-does-a-drop-stop-bouncing).
  • projects/index.md + assets/css/projects-v2.css — alphabetical list with title + link + repo path chip.
  • Nav — header link on all layouts that carry the nav; footer Explore column; command palette “Go to Project Docs”.

How to add a new entry

  1. Confirm https://comphy-lab.org/{Repo-Name}/ returns HTTP 200.
  2. Add { repo, title, note? } to _data/project-docs.yml.
  3. Keep titles roughly alphabetical (the page also sorts by title at build time).

Verification

  • JEKYLL_ENV=production bundle exec jekyll build/_site/projects/ renders 24 items.
  • Local serve at :4001/projects/ returns HTTP 200; nav + ElastoFlow/Viscoelastic3D link present.
  • npm test — 138 passed.

Out of scope / follow-ups

Open in Web Open in Cursor 

Summary by CodeRabbit

  • New Features
    • Added a Project docs index at /projects/, listing 25 live project documentation sites alphabetically.
    • Each entry shows its title, repository path, optional description, and documentation link.
    • Added Project docs links to the main navigation, footer, and key site pages.
    • Added a command-palette shortcut for opening Project docs.
  • Style
    • Added responsive styling for the project directory, including a mobile-friendly single-column layout.

Catalogue comphy-lab.org/{Repo-Name}/ Pages in _data/project-docs.yml,
render an alphabetical index, and link it from header, footer, and the
command palette. Fixes #40.

Co-authored-by: Vatsal Sanjay | CoMPhy Lab <vatsal.sanjay@comphy-lab.org>
@coderabbitai

coderabbitai Bot commented Sep 20, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Warning

Review limit reached

  • Ask an admin to enable usage-based reviews

Open in CodeRabbit

Reviews can continue after your included limit without a manual trigger. An admin must approve usage-based billing.

Next included review available in 1 minute.

Check out review usage here.

View limit details

Limit details: You’ve used all 5 included reviews currently available. Your 22 included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: 112355ed-988f-4067-859d-bb0fcec0dd76

📥 Commits

Reviewing files that changed from the base of the PR and between 78a1733 and f96db5f.

📒 Files selected for processing (6)
  • _data/project-docs.yml
  • projects/index.md
  • scripts/purge-website-cache.py
  • tests/browser-security.test.py
  • tests/command-data-actual.test.js
  • tests/purge-website-cache.test.py

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: c87fb864-4537-43ac-ba4f-bf6b71111111

📥 Commits

Reviewing files that changed from the base of the PR and between ea50f83 and 78a1733.

📒 Files selected for processing (9)
  • _data/project-docs.yml
  • _includes/footer-v2.html
  • _layouts/default.html
  • _layouts/history.html
  • _layouts/join-us.html
  • _layouts/team.html
  • assets/css/projects-v2.css
  • assets/js/command-data.js
  • projects/index.md

Included review availability: 1 review is currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: copilot-pull-request-reviewer
  • GitHub Check: Cursor Bugbot
🧰 Additional context used
📓 Path-based instructions (2)
`command-palette.js` must load **before** `command-data.js`

📄 CodeRabbit inference engine (AGENTS.md)

Files:

  • assets/js/command-data.js
80-char line limit for JavaScript.

📄 CodeRabbit inference engine (AGENTS.md)

Files:

  • assets/js/command-data.js
🔇 Additional comments (9)
_data/project-docs.yml (1)

1-66: LGTM!

projects/index.md (1)

1-55: LGTM!

_layouts/default.html (1)

96-98: LGTM!

Also applies to: 196-196

assets/css/projects-v2.css (1)

1-145: LGTM!

_layouts/history.html (1)

145-145: LGTM!

_layouts/join-us.html (1)

98-98: LGTM!

_layouts/team.html (1)

137-137: LGTM!

_includes/footer-v2.html (1)

19-19: LGTM!

assets/js/command-data.js (1)

43-51: LGTM!


📝 Walkthrough

Walkthrough

The site now provides a /projects/ index for 25 project documentation sites. It loads project data from YAML, renders sorted entries, applies responsive styling, and adds navigation links across the site.

Changes

Project documentation

Layer / File(s) Summary
Catalogue and project index
_data/project-docs.yml, projects/index.md
Defines project repositories, titles, and notes. The index sorts the entries and renders documentation links, paths, and the live-site count.
Project index styling
_layouts/default.html, assets/css/projects-v2.css
Loads page-specific CSS and styles the header, project rows, links, actions, footer, and responsive mobile layout.
Navigation entry points
_layouts/*.html, _includes/footer-v2.html, assets/js/command-data.js
Adds /projects/ links to site navigation, footer navigation, and command navigation.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant Visitor
  participant projects_index_md
  participant project_docs_yml
  Visitor->>projects_index_md: Request /projects/
  projects_index_md->>project_docs_yml: Read and sort project items
  projects_index_md-->>Visitor: Render project catalogue and documentation links
Loading
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarises the main change: adding the /projects/ documentation index. It also identifies the affected site and linked issue.
Linked Issues check ✅ Passed Issue #40 requests a page that provides access to CoMPhy Lab documentation, including the Viscoelastic3D site. projects/index.md creates /projects/, reads the project inventory, sorts entries, and…
Out of Scope Changes check ✅ Passed The changes remain connected to issue #40. The data file supplies the catalogue, the CSS styles the new page, and the header, footer, history, team, join-us, and command-palette links provide navigati…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
✨ Simplify code
  • Commit to this branch
  • Create a new PR

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

@VatsalSy
VatsalSy marked this pull request as ready for review September 20, 2026 21:59
Copilot AI lite review requested due to automatic review settings September 20, 2026 21:59
@comphy-bot

comphy-bot commented Sep 20, 2026

Copy link
Copy Markdown
Member

comphy-bot review status for comphy-lab/comphy-lab.github.io#115 at 78a17330: superseded

This review stopped because the pull request head changed.

@comphy-bot
comphy-bot self-requested a review September 20, 2026 22:02

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 78a1733. Configure here.

Comment thread projects/index.md

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

Project links need distinct accessible names, and command-palette regression coverage is requested.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 Low severity

Open (1)
What changed in this PR

Adds a public /projects/ catalogue for CoMPhy Lab documentation sites.

Changes:

  • Adds a YAML-driven 24-site project inventory and index page.
  • Adds responsive page styling.
  • Integrates project docs into navigation, footer, and command palette.
File Summary
projects/​index.md Renders the documentation catalogue.
assets/​js/​command-data.js Adds command-palette navigation.
assets/​css/​projects-v2.css Styles the projects page.
_layouts/​team.html Adds project navigation access.
_layouts/​join-us.html Adds project navigation access.
_layouts/​history.html Adds project navigation access.
_layouts/​default.html Loads styling and adds navigation.
_includes/​footer-v2.html Adds the footer link.
_data/​project-docs.yml Stores project metadata.

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

Comment thread assets/js/command-data.js
Bugbot flagged that the new index skipped Cloudflare CSP matching,
release-manifest inclusion, and post-deploy cache purge. Add it to
OWNED_DIRECTORY_ROOTS / OWNED_EXACT_PATHS and cover it in policy tests.

Co-authored-by: Vatsal Sanjay | CoMPhy Lab <vatsal.sanjay@comphy-lab.org>
Copilot AI review requested due to automatic review settings September 20, 2026 22:04
Cover the new projects command id, title, and target path so a future
route or ID change is caught by command-data-actual tests.

Co-authored-by: Vatsal Sanjay | CoMPhy Lab <vatsal.sanjay@comphy-lab.org>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🔵 Needs a closer look

Address the catalogue sorting issue and add the Project Docs link to the Team page’s legacy footer.

Review effort: Lite
Findings: None

Copilot AI review requested due to automatic review settings September 20, 2026 22:07
@VatsalSy VatsalSy closed this Sep 20, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🔵 Needs a closer look

The project index has a moderate, two-vote case-sensitive sorting issue that must be fixed before approval.

Review effort: Lite
Findings: None

Previously missed (1)

In code that hasn't changed since last review

Medium severity Use case-insensitive sorting for the public index

projects/​index.md:11

sort compares string values case-sensitively, so this does not implement the case-insensitive ordering promised in _data/project-docs.yml: for example, VE Drop Impact — Contact Line will sort before Vatsal Sanjay profile because E precedes lowercase a. Use Liquid's natural/case-insensitive sort so the public index remains alphabetically ordered.

@VatsalSy VatsalSy reopened this Sep 20, 2026
The catalogue YAML promises case-insensitive alphabetical order, but
Liquid sort is case-sensitive. Use sort_natural so titles like
VE Drop Impact do not precede Vatsal Sanjay profile.

Co-authored-by: Vatsal Sanjay | CoMPhy Lab <vatsal.sanjay@comphy-lab.org>
@VatsalSy

Copy link
Copy Markdown
Member Author

@comphy-bot note: addressing Copilot body finding on catalogue sort — switched projects/index.md to sort_natural: "title" so ordering matches the case-insensitive promise in _data/project-docs.yml.

Copilot AI review requested due to automatic review settings September 20, 2026 22:17
@VatsalSy VatsalSy closed this Sep 20, 2026
@VatsalSy VatsalSy reopened this Sep 20, 2026
@VatsalSy VatsalSy closed this Sep 20, 2026
@VatsalSy VatsalSy reopened this Sep 20, 2026
@comphy-bot

comphy-bot commented Sep 20, 2026

Copy link
Copy Markdown
Member

comphy-bot review status for comphy-lab/comphy-lab.github.io#115 at 79217c43: completed

Review completed for this exact pull request head.

@VatsalSy

Copy link
Copy Markdown
Member Author

@comphy-bot approve?

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🔵 Needs a closer look

Address the accessible project link names and inherited link-border styling.

Review effort: Lite
Findings: None

@comphy-bot comphy-bot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Review: Add /projects/ documentation index for CoMPhy Pages (Fixes #40) (#115)

Summary

+296/−0 across 13 files. Adds a public /projects/ catalogue of live CoMPhy Pages sites, with header/footer/command-palette entry and owned-path registration so CSP, release-manifest, and purge include the new route. No P0/P1 on this head.

Peer findings on earlier commits (owned-path CSP/purge registration, command-palette regression coverage, case-insensitive catalogue sort) are fixed at 79217c43.

Findings

P2 — Duplicate generic action-link names

File: projects/index.md:43
Layer: Maintainability / a11y
Impact: Every catalogue row exposes a second link whose accessible name is the identical Open docs ↗, so a screen-reader links list cannot tell which project it opens.
Detail: The title link already uses {{ p.title }} and the same href="/{{ p.repo }}/". The sibling .projects-list__action link repeats that destination with generic text.
Fix direction: Add aria-label="Open docs for {{ p.title }}" on the action link, or drop the duplicate action and keep the title as the sole link.

Missing Tests

None blocking. This diff already asserts the projects command-palette route, owned-path /projects/, and CSP starts_with(..., "/projects/").

Verification Steps

  • JEKYLL_ENV=production bundle exec jekyll build/_site/projects/ renders 24 items in natural title order
  • Confirm /projects/ is in OWNED_DIRECTORY_ROOTS so scripts/browser-security.py Cloudflare expression includes starts_with(http.request.uri.path, "/projects/")

documentationWeb is a test site for the docs tooling and VatsalSy is a personal
profile page; neither is project documentation, so they do not belong on the
public /projects/ index.
Copilot AI review requested due to automatic review settings September 20, 2026 22:44
@VatsalSy
VatsalSy merged commit d5d7061 into main Sep 20, 2026
6 checks passed
@VatsalSy
VatsalSy deleted the rayleigh-cloud/project-docs-index-25f0 branch September 20, 2026 22:45

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The inventory count conflicts with the stated totals and must be reconciled before approval.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 Medium severity

Open (1)

Comment thread _data/project-docs.yml
# title Human-readable label shown on /projects/.
# note Optional one-line context (shown muted under the title).

items:
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.

[Enhancement]: add a page for CoMPhy-Lab Wiki

4 participants