docs: clarify docs ownership and preview#10183
Open
codeMaestro78 wants to merge 4 commits intoanomalyco:devfrom
Open
docs: clarify docs ownership and preview#10183codeMaestro78 wants to merge 4 commits intoanomalyco:devfrom
codeMaestro78 wants to merge 4 commits intoanomalyco:devfrom
Conversation
Contributor
|
The following comment was made by an LLM, it may be inaccurate: No duplicate PRs found |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation to clarify the ownership and usage of OpenCode documentation, particularly distinguishing between the production docs and the Mintlify preview environment.
Changes:
- Updated OpenCode core README with clearer structure, development commands, and package contents
- Clarified that production docs live in
packages/web/src/content/docswhilepackages/docsis for Mintlify preview - Improved Mintlify setup and troubleshooting documentation with clearer instructions
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/opencode/README.md | Enhanced README with better title, package description, common development commands, and test instructions |
| packages/docs/development.mdx | Clarified docs ownership, improved Mintlify CLI instructions, reorganized troubleshooting, and removed deployment section |
| CONTRIBUTING.md | Added documentation ownership section explaining the distinction between production docs and Mintlify preview |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
00637c0 to
71e0ba2
Compare
f1ae801 to
08fa7f7
Compare
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.
What does this PR do?
How did you verify your code works?