|
| 1 | +# Agent instructions for Steeltoe Documentation |
| 2 | + |
| 3 | +## Scope and constraints |
| 4 | + |
| 5 | +- **This repo is primarily documentation.** Prefer minimal, surgical edits. Do not change application or build code unless the task explicitly requires it. |
| 6 | +- **When editing docs only:** do not modify `.github/workflows/` or `src/`. |
| 7 | +- **Version focus:** Steeltoe v4 is current; v2 and v3 are legacy. Prefer v4 paths and examples unless the task targets an older version. |
| 8 | + |
| 9 | +## Do / Don't |
| 10 | + |
| 11 | +| Do | Don't | |
| 12 | +| --- | --- | |
| 13 | +| Use `.md` extensions for internal links | Use `.html` in internal links | |
| 14 | +| Run the docfx build (see [README.md](README.md)) before committing doc changes; fix `InvalidFileLink` and similar warnings | Commit doc changes without validating | |
| 15 | +| Add new pages to the relevant `toc.yml` (see [docs/README.md](docs/README.md)) | Add new API version config without updating `build/metadata.conf` and the corresponding build API config files | |
| 16 | +| Use [docfx Flavored Markdown](https://dotnet.github.io/docfx/docs/markdown.html) | Change Blazor or workflow files unless the task explicitly requires it | |
| 17 | + |
| 18 | +## Where to find instructions |
| 19 | + |
| 20 | +**Use the READMEs as the source of truth.** Update them when build or content steps change; AGENTS.md only points to them. |
| 21 | + |
| 22 | +- **[README.md](README.md)** — Build order, commands to run the site locally, clean build (`git clean -xdff`). Run docfx before `dotnet run` or you get 404s and `InvalidFileLink` from `docs/api`. |
| 23 | +- **[build/README.md](build/README.md)** — API Browser: script, version/source switches, what the script does. |
| 24 | +- **[docs/README.md](docs/README.md)** — docfx layout, links and cross-references, YAML front matter options, creating blog posts and doc pages (including `toc.yml` examples). |
| 25 | + |
| 26 | +## Overview and layout |
| 27 | + |
| 28 | +This repository hosts the [Steeltoe website](https://steeltoe.io/): documentation and blog articles, built with ASP.NET Core Blazor and docfx. Key locations: |
| 29 | + |
| 30 | +- **`docs/`** — Content (see [docs/README.md](docs/README.md) for subdirs and content rules). |
| 31 | +- **`src/Steeltoe.io/`** — Blazor app; docfx output goes to `wwwroot`. |
| 32 | +- **`build/`** — API Browser script and config ([build/README.md](build/README.md)). |
| 33 | +- **CI** — `.github/workflows/build-and-stage.yml`. |
| 34 | + |
| 35 | +## Linting and config |
| 36 | + |
| 37 | +- Markdown: `.markdownlint.json` |
| 38 | +- Editor: `.editorconfig` |
| 39 | + |
| 40 | +## Resources |
| 41 | + |
| 42 | +- **Canonical instructions:** [README.md](README.md), [build/README.md](build/README.md), [docs/README.md](docs/README.md). |
| 43 | +- [docfx documentation](https://dotnet.github.io/docfx) · [docfx Flavored Markdown](https://dotnet.github.io/docfx/docs/markdown.html) |
| 44 | +- [Steeltoe website](https://steeltoe.io) · [ASP.NET Core Blazor](https://learn.microsoft.com/aspnet/core/blazor/) |
0 commit comments