Fix links to documentation - #33
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The updated links likely need a .html suffix to reliably resolve on the published docs site, otherwise they may 404.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates documentation links in the contributing guide to point to the published Yii internal docs site instead of GitHub docs repository markdown files.
Changes:
- Replaced prerequisites links to use
https://yiisoft.github.io/docs/internals/... - Updated the “development tool” and “roadmap” links to the same docs host
File summaries
| File | Description |
|---|---|
| .github/CONTRIBUTING.md | Updates contributor documentation links to the published Yii docs site |
Review details
Suppressed comments (2)
.github/CONTRIBUTING.md:11
- The docs site typically uses
.htmlURLs for these internal pages; consider updating this link to include the.htmlsuffix to avoid potential 404s.
Since Yii 3 consists of many packages, we have a [special development tool](https://yiisoft.github.io/docs/internals/005-development-tool).
.github/CONTRIBUTING.md:21
- The published docs URL format appears to use
.htmlfor this page; using the.htmlsuffix is more likely to work consistently.
- [Check roadmap](https://yiisoft.github.io/docs/internals/003-roadmap).
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+3
to
+7
| - [Yii goal and values](https://yiisoft.github.io/docs/internals/001-yii-values) | ||
| - [Namespaces](https://yiisoft.github.io/docs/internals/004-namespaces) | ||
| - [Git commit messages](https://yiisoft.github.io/docs/internals/006-git-commit-messages) | ||
| - [Exceptions](https://yiisoft.github.io/docs/internals/007-exceptions) | ||
| - [Interfaces](https://yiisoft.github.io/docs/internals/008-interfaces) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.