Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Add links to about pages of current templates #243

Merged
merged 3 commits into from
Apr 17, 2022
Merged

Add links to about pages of current templates #243

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70f1469
Add links to about pages of current templates
Linda-Ikechukwu Mar 22, 2022
b3b30ac
Update README.md
barbaricyawps Apr 17, 2022
50e8efe
Update README.md
barbaricyawps Apr 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,14 +50,14 @@ Current templates:

| Template name | Documentation type | Description |
| ------------- | ------------------ | ----------- |
| API Project overview | Concept | An overview of your API |
| API Quickstart | Concept, Task | Simplest possible method of implementing your API |
| API Reference | Reference | List of references related to your API |
| Explanation | Concept | Longer document giving background or context to a topic |
| How-to | Task | A concise set of numbered steps to do one task with the product. |
| Tutorial | Concept, Task | Instructions for setting up an example project using the product, for the purpose of learning. |
| General reference entry | Reference | Specific details about a particular topic |
| Logging reference | Reference | Description of log pipelines |
| [API Project overview](about-overview.md) | Concept | An overview of your API |
| [API Quickstart](api-quickstart/about-quickstart.md) | Concept, Task | Simplest possible method of implementing your API |
| [API Reference](https://github.com/thegooddocsproject/templates/blob/dev/api-reference/about-api-reference.md) | Reference | List of references related to your API |
| [Explanation](https://github.com/thegooddocsproject/templates/blob/dev/explanation/about-explanation.md) | Concept | Longer document giving background or context to a topic |
| [How-to](https://github.com/thegooddocsproject/templates/blob/dev/how-to/about-how-to.md) | Task | A concise set of numbered steps to do one task with the product. |
| [Tutorial](https://github.com/thegooddocsproject/templates/blob/dev/tutorial/about-tutorial.md) | Concept, Task | Instructions for setting up an example project using the product, for the purpose of learning. |
| [General reference entry](https://github.com/thegooddocsproject/templates/blob/dev/reference/about-reference.md) | Reference | Specific details about a particular topic |
| [Logging reference](https://github.com/thegooddocsproject/templates/blob/dev/logging/about-logging.md) | Reference | Description of log pipelines |

## The cookbook

Expand Down