StackGuardian / StackGuardian/tirith
research(docs): an assistant-facing authoring guide
Open
Beginner friendly
Nobody has claimed this yet.
research
- Dominant language
- Python
- Stars
- 165
- Forks
- 42
- Avg merge
- 1d 3h
- Merged PRs (30d)
- 11
Description
A skills/guide file teaching AI coding assistants to author Tirith policies is cheap and useful.
Keep it a plain docs/ file, added after the launch window so the project's public surface stays
focused on the engine.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Create a plain file under docs/ focused on teaching AI coding assistants how to author Tirith policies. Keep the guide separate from the engine's public surface and verify that it clearly covers policy authoring; the work is complete when the documented guide exists in docs/ and is positioned after the launch window.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 78/100