Skip to content

Commit

Permalink
Review "About our documentation design" page (#541)
Browse files Browse the repository at this point in the history
  • Loading branch information
jdbaldry authored Feb 26, 2024
1 parent 0869873 commit a87b371
Showing 1 changed file with 27 additions and 14 deletions.
41 changes: 27 additions & 14 deletions docs/sources/structure/about-documentation-design/index.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,42 @@
---
title: About our documentation design
menuTitle: Documentation design
description: Learn about Grafana's documentation docs pages
weight: 100
aliases:
- /docs/writers-toolkit/writing-guide/about-documentation-design/
- /docs/writers-toolkit/structure/about-documentation-design/
date: 2024-02-26
description: Learn about the design of Grafana's documentation pages
keywords:
- Grafana
- documentation
- page design
menuTitle: Documentation design
title: About documentation design at Grafana Labs
weight: 100
---

# About our documentation design
# About documentation design at Grafana Labs

<!-- vale Grafana.GoogleWe = NO -->
<!-- According to https://developers.google.com/style/pronouns#personal-pronouns, it is acceptable to use personal pronouns "after using your organization's name". -->

The documentation website uses a modern design approach to make our technical documentation accessible, modern, and scalable.
Our documentation website uses a modern design approach to make technical documentation accessible and scalable.

Our technical documentation pages take advantage of our static site generator, Hugo. As a result, several elements of the page are automatically managed during the publication of the page using Hugo's taxonomy. Thus, the source markdown files **do not need to hand management** of these elements and **do not require** contributors to curate them.
Documentation pages take advantage of the static site generator Hugo.
As a result, several elements of the page are automatically managed during the publication of the page using Hugo's taxonomy.
Thus, the source Markdown files _don't need to hand management_ of these elements and _don't require_ contributors to curate them.

We also include:
Pages also include:

- **Navigation to preview primary topics.** The left-hand sidebar broadly outlines key topics, with nested related topics underneath. This design supports the philosophy that "every page is page one" and creates an system of documentation around a topic that is easier to reference and navigate.
- **Floating table of contents.** The table of contents floats on the page as you scroll to the content that's hidden beneath the fold. You can also view the upcoming topics, to enable a better user experience that helps you navigate to subtopics lower on the page.
- **Auto-generated _Related documentation_.** Using Hugo's taxonomy, our documentation automatically finds other documentation that's pertinent to the page you're viewing.
- **Auto-generated _Related resources from Grafana Labs_.** Hugo's taxonomy again is used to automatically generate this content.
- **Feedback.** We added more prominent options for feedback from our community.
- **Navigation to preview primary topics.**
The left-hand sidebar broadly outlines key topics, with nested related topics underneath.
This design supports the philosophy that "every page is page one" and creates an system of documentation around a topic that's easier to reference and navigate.
- **Floating table of contents.**
The table of contents floats on the page as you scroll to the content that's hidden beneath the fold.
You can also view the upcoming topics, to enable a better user experience that helps you navigate to subtopics lower on the page.
- **Auto-generated _Related documentation_.**
Using Hugo's taxonomy, documentation automatically finds other documentation that's related to the page you're viewing.
- **Auto-generated _Related resources from Grafana Labs_.**
Hugo's taxonomy again automatically generates this content.
- **Feedback.**
Thumbs up and thumbs down feedback.

You can read about the redesign of our documentation pages in our [blog](/blog/2023/02/03/grafana-documentation-a-look-at-the-new-and-improved-design/).
You can read about the redesign of our documentation pages in [Grafana documentation: A look at the new and improved design](https://grafana.com/blog/2023/02/03/grafana-documentation-a-look-at-the-new-and-improved-design/).

0 comments on commit a87b371

Please sign in to comment.