Skip to content

Commit 2560ef9

Browse files
authored
Fix AGENTS.md prettier formatting (#691)
## Summary - Fix markdown formatting in AGENTS.md to pass prettier checks - Normalizes `*` list markers to `-` and double backticks to single Made by AI
1 parent 020040d commit 2560ef9

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

AGENTS.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Read the Docs is a documentation hosting platform that builds and hosts document
66
It supports multiple documentation tools (Sphinx, MkDocs, etc.) and automatically builds documentation from Git repositories.
77

88
**Technology Stack:**
9+
910
- Python 3.x
1011
- Django web framework
1112
- Docker and Docker Compose for development
@@ -15,16 +16,16 @@ It supports multiple documentation tools (Sphinx, MkDocs, etc.) and automaticall
1516

1617
## Commits
1718

18-
* Use short descriptive commit messages
19-
* Only provide simple context, and don't be overly verbose
19+
- Use short descriptive commit messages
20+
- Only provide simple context, and don't be overly verbose
2021

2122
## Pull Requests
2223

23-
* Put a footer note that this was generated by Copilot
24-
* Use feature branches for all changes
25-
* Don't include a "Changes" section, since the PR content is self-explanatory
26-
* Link related issues in the PR description, if there are any in the chat context
27-
* Prefix pull request titles with the part of the system being worked on, for example `api:`, `builds:`, or `docs:`.
24+
- Put a footer note that this was generated by Copilot
25+
- Use feature branches for all changes
26+
- Don't include a "Changes" section, since the PR content is self-explanatory
27+
- Link related issues in the PR description, if there are any in the chat context
28+
- Prefix pull request titles with the part of the system being worked on, for example `api:`, `builds:`, or `docs:`.
2829

2930
## Package Management
3031

@@ -34,9 +35,9 @@ It supports multiple documentation tools (Sphinx, MkDocs, etc.) and automaticall
3435

3536
## Docs
3637

37-
* Follow the style guide at https://github.com/readthedocs/readthedocs.org/blob/main/docs/dev/style-guide.rst.
38-
* Always use the marketing name used in the public-facing docs, and not the internal code names referenced in code.
39-
* The ``user`` directory is public docs, and ``dev`` is dev-focused. Most of what we do is focus on the user-facing docs.
38+
- Follow the style guide at https://github.com/readthedocs/readthedocs.org/blob/main/docs/dev/style-guide.rst.
39+
- Always use the marketing name used in the public-facing docs, and not the internal code names referenced in code.
40+
- The `user` directory is public docs, and `dev` is dev-focused. Most of what we do is focus on the user-facing docs.
4041

4142
## Testing
4243

@@ -45,7 +46,7 @@ It supports multiple documentation tools (Sphinx, MkDocs, etc.) and automaticall
4546
- Write succinct, focused tests that test one thing at a time
4647
- Use descriptive test names that explain what is being tested
4748
- Place tests in appropriate test files following the project structure
48-
- Always keep the test db with ``pytest --reuse-db`` to speed up test runs
49+
- Always keep the test db with `pytest --reuse-db` to speed up test runs
4950

5051
## Code Quality
5152

0 commit comments

Comments
 (0)