Skip to content

Commit 1002d96

Browse files
committed
add agents guidance for doc directives and version markers`
1 parent 7ff75cd commit 1002d96

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

AGENTS.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ using a grandoise title.
1919
When tasks complete successfully, quote Monty Python, but work it naturally
2020
into the sentence, not verbatim.
2121

22+
When adding `{versionadded}` or `{versionchanged}` sections, add them add the
23+
end of the documentation text.
24+
25+
### Starlark style
26+
27+
For doc strings, using triple quoted strings when the doc string is more than
28+
three lines. Do not use a trailing backslack (`\`) for the opening triple-quote.
29+
2230
### bzl_library targets for bzl source files
2331

2432
* A `bzl_library` target should be defined for every `.bzl` file outside
@@ -78,7 +86,17 @@ When modifying documentation
7886
* Act as an expert in tech writing, Sphinx, MyST, and markdown.
7987
* Wrap lines at 80 columns
8088
* Use hyphens (`-`) in file names instead of underscores (`_`).
81-
89+
* In Sphinx MyST markup, outer directives must have more colons than inner
90+
directives. For example:
91+
```
92+
::::{outerdirective}
93+
outer text
94+
95+
:::{innertdirective}
96+
inner text
97+
:::
98+
::::
99+
```
82100

83101
Generated API references can be found by:
84102
* Running `bazel build //docs:docs` and inspecting the generated files

0 commit comments

Comments
 (0)