Skip to content

Commit c8b0a11

Browse files
committed
Add astro tutorial as example
1 parent 6daa2c6 commit c8b0a11

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ TODO:
77

88
# Awesome Documentation [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) [![Lint](https://github.com/pengqun/awesome-documentation/actions/workflows/action.yml/badge.svg)](https://github.com/pengqun/awesome-documentation/actions/workflows/action.yml)
99

10-
Translations available in: [🇨🇳 中文](README_zh.md)
11-
1210
> A curated and **up-to-date** list of resources on software documentation templates, tools, guides & examples.
1311
1412
Software documentation is crucial for ensuring clarity and efficiency throughout the development process, by facilitating better understanding and collaboration among team members. However, for various reasons, the creation and maintenance of documentation has frequently been mishandled, resulting in lots of inefficiency, inconsistency, and poor quality.
1513

1614
This list aims to assist by providing you with out-of-box templates and practical tools to maximize efficiency, insightful guides and established standards to ensure consistency, and real-world documents to serve as examples.
1715

16+
Translations available in: [🇨🇳 中文](README_zh.md)
17+
1818
## Contents
1919

2020
- [Documentation Types](#documentation-types)
@@ -56,6 +56,7 @@ Step-by-step instructions to teach users how to use or implement the subject or
5656
- [Tutorial](https://documentation.divio.com/tutorials.html) - Lean how to write good tutorials from The Documentation System.
5757
- [Tutorial template](https://gitlab.com/tgdp/templates/-/blob/main/tutorial/template-tutorial.md) - Open-source template provided by The Good Docs Project.
5858
- [Writing a perfect technical tutorial](https://www.writethedocs.org/videos/portland/2021/writing-a-perfect-technical-tutorial-jessica-garson/) - How to start creating tutorials, gather feedback, and the next steps once the tutorial is published.
59+
- [Example: Build your first Astro Blog](https://docs.astro.build/en/tutorial/0-introduction/) - A well-structured and good-looking tutorial that covers Astro’s key features by building a fully-functioning blog, from zero to full launch.
5960

6061
#### Reference
6162

0 commit comments

Comments
 (0)