Skip to content

docs: clarify docs ownership and preview#10183

Open
codeMaestro78 wants to merge 4 commits intoanomalyco:devfrom
codeMaestro78:docs/refresh-docs-guidance
Open

docs: clarify docs ownership and preview#10183
codeMaestro78 wants to merge 4 commits intoanomalyco:devfrom
codeMaestro78:docs/refresh-docs-guidance

Conversation

@codeMaestro78
Copy link

What does this PR do?

  • Updates documentation guidance for the Mintlify preview and docs ownership. Clarifies where the source of truth lives, how to run the local preview, and improves the OpenCode core README summary and common commands.

How did you verify your code works?

  • Manual review of docs and commands against the repository layout and scripts; no runtime changes, so no tests were run.

Copilot AI review requested due to automatic review settings January 23, 2026 07:50
@github-actions
Copy link
Contributor

The following comment was made by an LLM, it may be inaccurate:

No duplicate PRs found

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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/docs while packages/docs is 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.

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.

1 participant