Skip to content

Commit cdbcde1

Browse files
committed
Update Copilot instructions
Signed-off-by: Dan Barr <[email protected]>
1 parent 9619b65 commit cdbcde1

File tree

1 file changed

+44
-10
lines changed

1 file changed

+44
-10
lines changed

.github/instructions/writing-style.instructions.md renamed to .github/copilot-instructions.md

Lines changed: 44 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,57 @@
1-
---
2-
applyTo: '**/*.md,**/*.mdx'
3-
---
1+
# Project overview
42

5-
# Writing and markdown instructions for documentation
3+
This is the user-facing documentation for ToolHive, an open source tool that
4+
helps you run and manage Model Context Protocol (MCP) servers easily and
5+
securely. The site is built using Docusaurus and deployed with Vercel.
6+
7+
## Folder structure
8+
9+
- `/docs`: contains the main documentation files. Each file corresponds to a
10+
page in the documentation.
11+
- `/static`: contains static assets like images, icons, and other files that are
12+
served directly.
13+
- `/src`: contains the source code for the website, including components,
14+
styles, and customizations.
15+
16+
## Primary configuration files
17+
18+
- `/docusaurus.config.ts`: the main configuration file for Docusaurus, where you
19+
define site metadata, theme, plugins, and other settings.
20+
- `/sidebars.ts`: defines the structure of the documentation sidebar, including
21+
which pages appear in the sidebar and their order.
22+
- `/vercel.json`: configuration file for Vercel deployment, specifying build
23+
settings and redirects.
24+
25+
## Libraries and tools
26+
27+
- Docusaurus for the documentation site framework.
28+
- React and TypeScript for building custom components and pages.
29+
- npm for package management.
30+
- Vercel for deployment and hosting.
31+
32+
Code quality tools:
33+
34+
- Prettier for code formatting.
35+
- markdownlint for enforcing Markdown style conventions.
36+
- ESLint for JavaScript/TypeScript linting.
637

738
## Audience
839

9-
The primary audience for this documentation is developers and DevOps
10-
professionals who want to run and manage Model Context Protocol (MCP) servers
11-
using ToolHive. They may be new to MCP servers or have some experience with
12-
them.
40+
The primary audience is developers and DevOps professionals who want to run and
41+
manage Model Context Protocol (MCP) servers using ToolHive. They may be new to
42+
MCP servers or have some experience with them.
1343

1444
The documentation should be accessible to a wide range of technical users,
1545
including those who may not be familiar with the specific technologies used in
1646
ToolHive.
1747

18-
## Language, tone, and voice
48+
## Writing style guide
49+
50+
The primary goal of the documentation is to be clear, concise, and
51+
user-friendly. The writing style should be approachable and easy to understand,
52+
while still providing the necessary technical details.
1953

20-
- The project's official language is US English.
54+
The project's official language is US English.
2155

2256
### Tone and voice
2357

0 commit comments

Comments
 (0)