Fix broken links to removed files in contributor docs - #5351
Conversation
Three relative links in the contributor-facing docs point at files that no longer exist, so they 404 on GitHub: - CONTRIBUTING.md and DEVELOPER_GUIDE.md link to mathesar/api/STANDARDS.md and mathesar/api/README.md, both removed in c73b663 ("remove mathesar/api/"). The API standards doc has no successor, so drop the link; the API guide is superseded by the published API docs, so point there instead. - mathesar_ui/README.md links to mathesar/tests/integration/README.md, removed in 3e32316 ("remove disabled integration tests"). The integration tests it described are gone, so drop the stale subsection. Docs only; no code or behavior changes.
📝 WalkthroughWalkthroughUpdated repository documentation to reference front-end standards, link to the official API documentation, and remove the UI integration-test documentation subsection. ChangesDocumentation guidance
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 43: Update the wording in CONTRIBUTING.md to hyphenate “front-end” in the
referenced code standards description, leaving the link and surrounding text
unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 83c93bb8-6e61-4e62-9ce1-3e15c3754482
📒 Files selected for processing (3)
CONTRIBUTING.mdDEVELOPER_GUIDE.mdmathesar_ui/README.md
💤 Files with no reviewable changes (1)
- mathesar_ui/README.md
|
Friendly ping on this one — CI is green and it's still mergeable. It's a small docs-only change removing links to files that no longer exist, so it should be a quick look whenever someone has a moment. Happy to rebase if it's gone stale. |
Description
Three relative links in the contributor-facing docs point at files that no longer exist, so they 404 on GitHub. I found them while reading through the contributor docs, and each target was removed some time ago:
CONTRIBUTING.mdmathesar/api/STANDARDS.mdDEVELOPER_GUIDE.mdmathesar/api/README.mdmathesar_ui/README.mdmathesar/tests/integration/README.mdChanges
mathesar/api/is gone, so I dropped just that link and left the front end standards link intact.Docs only; no code or behavior changes. After this, every relative link in the repo's markdown (outside
docs/, which mkdocs resolves separately) resolves to a file that exists.Question for reviewers
db/sql/STANDARDS.mddoes still exist. Would you like it linked from that CONTRIBUTING.md line in place of the removed API standards, e.g. "follow our front end code standards and SQL code standards where applicable"? Happy to add it if so — I left it out to keep the change strictly a fix.Summary by CodeRabbit