Skip to content

Commit

Permalink
Add a link between docs guidelines (#6111)
Browse files Browse the repository at this point in the history
* Update writing-docs.md

Add a link to reference docs guide.

* Update writing-docs.md
  • Loading branch information
thampiotr authored Jan 11, 2024
1 parent d226a0e commit 28a8f20
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/developer/writing-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ The Reference section is a collection of pages that describe the Agent
components and their configuration options exhaustively. This is a more narrow
definition than the one found in the [writer's toolkit][].

We have a dedicated page with the best practices for writing Reference
docs: [writing flow components documentation][writing-flow-docs].

This is our most detailed documentation, and it should be used as a source of
truth. The contents of the Reference pages should not be repeated in other parts
of the documentation.
Expand All @@ -76,3 +79,4 @@ Release notes contain all the notable changes in the Agent. They are updated as
part of the release process.

[writer's toolkit]: https://grafana.com/docs/writers-toolkit/structure/topic-types/
[writing-flow-docs]: writing-flow-component-documentation.md

0 comments on commit 28a8f20

Please sign in to comment.