Skip to content

Commit 9c65e24

Browse files
authored
Rename Introduction to User Guide and move Tutorials next to it (#701)
`User Guide` is a more suitable name for the section that contains the basic information about the SDK and how to use it. It is also more broad, as it allow us to also include more advanced topics in the same section. Having the `Tutorials` section next to it seems like a more natural order for reading the documentation. The users can read the user guide first and then go through the tutorials to have a more hands-on experience.
2 parents bd7822c + 0ff4ec2 commit 9c65e24

File tree

5 files changed

+3
-3
lines changed

5 files changed

+3
-3
lines changed

docs/SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
* [Home](index.md)
2-
* [Introduction](intro/)
3-
* [API Reference](reference/)
2+
* [User Guide](user-guide/)
43
* [Tutorials](tutorials/)
4+
* [API Reference](reference/)
55
* [Contributing](CONTRIBUTING.md)

docs/_scripts/macros.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def glossary(term: str) -> str:
5555
The Markdown link to the glossary entry for the given term.
5656
"""
5757
current_path = pathlib.Path(env.page.file.src_uri)
58-
glossary_path = pathlib.Path("intro/glossary.md")
58+
glossary_path = pathlib.Path("user-guide/glossary.md")
5959
link_path = glossary_path.relative_to(current_path.parent)
6060
return f"[{term}]({link_path}#{_slugify(term)})"
6161

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)