Skip to content

Commit c7e75c5

Browse files
authored
feat: Glossary page added (#421)
* feat: New glossary section added * feat: Procedural Model term updated * feat: Copilot instrutions added * feat: Content updated * docs: More content added * feat: More key terms added * docs: Update Recent Updates section
1 parent 610d10f commit c7e75c5

File tree

4 files changed

+268
-13
lines changed

4 files changed

+268
-13
lines changed

.github/copilot-instructions.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Copilot Guidance for Stride Documentation
2+
3+
These repository instructions guide GitHub Copilot (and similar AI assistants) when updating the Stride game engine documentation.
4+
5+
## Do not build or run this repository
6+
> [!IMPORTANT]
7+
> This is a documentation-only repository. Do not try to build, run, or test it. Do not use IDE build features, build/output windows, or commands such as `dotnet build`, `dotnet run`, or `npm` scripts. Avoid looking for compiler warnings/errors or attempting to fix build issues.
8+
9+
## Repository scope and layout
10+
- Primary content: Markdown under `en/`.
11+
- Navigation/ToC: `en/manual/toc.yml`.
12+
- Glossary: `en/manual/glossary/index.md`.
13+
- Code samples/snippets may appear in articles but are illustrative; they are not compiled from this repo.
14+
15+
## Editing conventions
16+
- Use DocFX-style admonitions: `[!NOTE]`, `[!TIP]`, `[!IMPORTANT]`, `[!WARNING]`.
17+
- One H1 (`#`) title per page at the top; use sentence case for headings.
18+
- Prefer concise, task-focused writing; avoid redundancy.
19+
- Use fenced code blocks with language hints (e.g., ```csharp, ```yaml, ```json).
20+
- Use relative links within the repo; avoid absolute site URLs.
21+
- Place images alongside content (e.g., a sibling `media/` folder) and reference with relative paths.
22+
- When adding/moving pages, update `en/manual/toc.yml` accordingly.
23+
24+
## Allowed tasks for Copilot
25+
- Create or update Markdown files under `en/`.
26+
- Update `en/manual/toc.yml` to reflect navigation changes.
27+
- Add or correct links, anchors, code fences, and admonitions.
28+
- Improve clarity, grammar, and consistency while preserving technical accuracy.
29+
30+
## Disallowed tasks for Copilot
31+
- Building, running, or testing the repository.
32+
- Using IDE build/output logs to guide changes.
33+
- Modifying `.csproj` or adding packages/dependencies.
34+
- Creating or altering non-docs code projects.
35+
36+
## Maintenance
37+
> [!IMPORTANT]
38+
> Keep this document current (structural changes, new sections, deprecations) so AI assistance stays accurate.
39+
40+
- Update when folder structure, naming conventions, or tooling changes.
41+
- Prune outdated or redundant guidelines.
42+
43+
---
44+
If something here becomes outdated or ambiguous, update it promptly. Concise, accurate guidance improves AI output quality and reduces maintenance overhead.

0 commit comments

Comments
 (0)