Skip to main content

Writing with GitHub Copilot

GitHub Copilot can accelerate documentation authoring. This page provides prompt templates tailored to the Rhino Group Docs platform structure.

General Page Creation Prompt​

Use this when creating a new documentation page for any client/site:

Create a new documentation page for the {site-name} site under the {client-name} client.

Topic: {topic}
Category: {category-name}
File path: clients/{client-slug}/{site-slug}/{category}/{filename}.md

Requirements:
- Include frontmatter with sidebar_position, id, title, and sidebar_label
- Use the existing page style from this site (check sibling files)
- Include a top-level heading matching the title
- Use tables for structured data
- Use code blocks with appropriate language tags
- Use Docusaurus admonitions (:::note, :::tip, :::caution) where appropriate
- Use relative links to reference other pages in the same site

New Client Setup Prompt​

I need to add a new client called "{client-name}" to the Rhino Group Docs platform.
They have the following sites:
- {site-1-name} ({site-1-url})
- {site-2-name} ({site-2-url})

Please:
1. Run the create-new-client-site.ps1 wizard for each site
2. Create intro.md files with proper overviews
3. Set up initial category directories with _category_.json files
4. Ensure all registration files are updated (homepage, search bar)

Content Migration Prompt​

When migrating documentation from another system:

Migrate the following documentation into the Rhino Group Docs platform.

Source: {source-description}
Target: clients/{client-slug}/{site-slug}/

Requirements:
- Convert to Markdown with proper frontmatter (sidebar_position, id, title, sidebar_label)
- Create _category_.json files for each category directory
- Use relative links for internal references
- Remove any references to the old documentation system
- Preserve code blocks, tables, and admonitions
- Ensure intro.md exists as the site root document

Frontmatter Template​

Every page needs this structure:

---
sidebar_position: {N}
id: {unique-id}
title: {Full Page Title}
sidebar_label: {Short Label}
---

Style Guidelines​

When writing or generating documentation for this platform:

  1. Headings: Use # for the page title (matching title frontmatter), ## for major sections, ### for subsections
  2. Tables: Use Markdown tables for structured data (config values, API endpoints, environment variables)
  3. Code blocks: Always specify the language (bash, php, ts, json, yaml, etc.)
  4. Admonitions: Use :::note for info, :::tip for helpful hints, :::caution for warnings, :::danger for critical warnings
  5. Links: Use relative paths within a site (../category/page), not absolute paths
  6. Horizontal rules: Use --- to separate major sections
  7. Lists: Use unordered lists for features/items, ordered lists for step-by-step instructions