Skip to content

Commit ee4dace

Browse files
author
Scott Arbeit
committed
Update auth docs, config, and parallel tests
1 parent 4ac0ee7 commit ee4dace

File tree

9 files changed

+739
-118
lines changed

9 files changed

+739
-118
lines changed

.beads/last-touched

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Grace-9e0
1+
Grace-328

AGENTS.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,30 @@ Run `bd prime` for workflow context, or install hooks (`bd hooks install`) for a
4141
- `bd sync` - Sync with git (run at session end)
4242

4343
For full workflow details: `bd prime`
44+
45+
## Markdown guidelines
46+
47+
- Follow the MarkdownLint ruleset found at
48+
`https://raw.githubusercontent.com/DavidAnson/markdownlint/refs/heads/main/doc/Rules.md`.
49+
- Verify updates by running MarkdownLint. Use `npx --yes markdownlint-cli2 ...`. `--help` is available.
50+
- For MD013, override the guidance to allow for 120-character lines.
51+
52+
## Editing Documentation
53+
54+
When updating documentation files, follow these guidelines:
55+
56+
- When writing technical documentation, act as a friendly peer engineer helping other developers to understand Grace as a project.
57+
- When writing product-focused documentation, act as an expert product manager who helps a tech-aware audience understand Grace as a product, and helps end users understand how to use Grace effectively.
58+
- Use clear, concise language; avoid jargon. The tone should be welcoming and informative.
59+
- Structure content with headings and subheadings. Intersperse written (paragraph / sentence form) documentation with bullet points for readability.
60+
- Keep documentation up to date with code changes; review related docs when modifying functionality. Explain all documentation changes clearly, both what is changing, and why it's changing.
61+
- Show all scripting examples in both (first) PowerShell and (then, second) bash/zsh, where applicable. bash and zsh are always spelled in lowercase. Good example:
62+
63+
PowerShell:
64+
```powershell
65+
$env:GRACE_SERVER_URI="http://localhost:5000"
66+
```
67+
bash / zsh:
68+
```bash
69+
export GRACE_SERVER_URI="http://localhost:5000"
70+
```

0 commit comments

Comments
 (0)