diff --git a/.github/instructions/writing-style.instructions.md b/.github/copilot-instructions.md similarity index 75% rename from .github/instructions/writing-style.instructions.md rename to .github/copilot-instructions.md index e3824586..b90c18d6 100644 --- a/.github/instructions/writing-style.instructions.md +++ b/.github/copilot-instructions.md @@ -1,23 +1,57 @@ ---- -applyTo: '**/*.md,**/*.mdx' ---- +# Project overview -# Writing and markdown instructions for documentation +This is the user-facing documentation for ToolHive, an open source tool that +helps you run and manage Model Context Protocol (MCP) servers easily and +securely. The site is built using Docusaurus and deployed with Vercel. + +## Folder structure + +- `/docs`: contains the main documentation files. Each file corresponds to a + page in the documentation. +- `/static`: contains static assets like images, icons, and other files that are + served directly. +- `/src`: contains the source code for the website, including components, + styles, and customizations. + +## Primary configuration files + +- `/docusaurus.config.ts`: the main configuration file for Docusaurus, where you + define site metadata, theme, plugins, and other settings. +- `/sidebars.ts`: defines the structure of the documentation sidebar, including + which pages appear in the sidebar and their order. +- `/vercel.json`: configuration file for Vercel deployment, specifying build + settings and redirects. + +## Libraries and tools + +- Docusaurus for the documentation site framework. +- React and TypeScript for building custom components and pages. +- npm for package management. +- Vercel for deployment and hosting. + +Code quality tools: + +- Prettier for code formatting. +- markdownlint for enforcing Markdown style conventions. +- ESLint for JavaScript/TypeScript linting. ## Audience -The primary audience for this documentation is developers and DevOps -professionals who want to run and manage Model Context Protocol (MCP) servers -using ToolHive. They may be new to MCP servers or have some experience with -them. +The primary audience is developers and DevOps professionals who want to run and +manage Model Context Protocol (MCP) servers using ToolHive. They may be new to +MCP servers or have some experience with them. The documentation should be accessible to a wide range of technical users, including those who may not be familiar with the specific technologies used in ToolHive. -## Language, tone, and voice +## Writing style guide + +The primary goal of the documentation is to be clear, concise, and +user-friendly. The writing style should be approachable and easy to understand, +while still providing the necessary technical details. -- The project's official language is US English. +The project's official language is US English. ### Tone and voice diff --git a/.github/prompts/doc-review.prompt.md b/.github/prompts/doc-review.prompt.md new file mode 100644 index 00000000..e1a66452 --- /dev/null +++ b/.github/prompts/doc-review.prompt.md @@ -0,0 +1,37 @@ +--- +mode: agent +tools: ['codebase', 'problems', 'changes', 'editFiles', 'runCommands'] +description: 'Perform a documentation clarity and style review' +--- + +Perform a review of the documentation provided in the context. + +If explicit content is not provided, perform a review of all changes between the +current branch and the `main` branch, including committed and unstaged changes. +Use a PR-style approach: review all changed files, including documentation and +code, and provide actionable feedback. + +**Review instructions:** + +- Focus on clarity, conciseness, technical accuracy, and adherence to the + writing style guide. +- For documentation, check tone, accessibility, and user-friendliness for + developers and DevOps professionals. +- For code, check correctness, readability, maintainability, and adherence to + project conventions. +- Use inline comments or suggestions for specific lines or sections. +- Summarize major issues and list minor suggestions. +- Indicate whether you would "approve", "request changes", or "comment" as in a + typical PR review. + +Refer to the writing style guide: +[copilot-instructions.md](../copilot-instructions.md) + +You can run `editFiles` to make changes based on your review. You can also run +`runCommands` to test the site or check for errors: + +- `npm run build` to build the documentation site. +- `npm run start` to start the local development server. +- `npm run prettier` to check formatting. +- `npm run markdownlint` to check for linting errors. +- `npm run eslint` to check for JavaScript/TypeScript linting errors. diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc index 1dcd1b13..08c3e9b9 100644 --- a/.markdownlint-cli2.jsonc +++ b/.markdownlint-cli2.jsonc @@ -5,5 +5,6 @@ "docs/toolhive/reference/cli/", "static/api-specs/*.md", ".github/pull_request_template.md", + ".github/prompts/*.md", ], }