You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+12-1
Original file line number
Diff line number
Diff line change
@@ -82,14 +82,20 @@ Answers frequently asked questions to quickly resolve common issues or clarify t
82
82
83
83
-[The Facts About FAQs](https://www.writethedocs.org/videos/portland/2018/the-facts-about-faqs-ashleigh-rentz/) - Explore various questions we might frequently ask ourselves about FAQs.
84
84
85
+
#### In-app
86
+
87
+
Wizards, tooltips, onboarding, etc.
88
+
89
+
-[Driver.js](https://github.com/kamranahmedse/driver.js) - A light-weight, no-dependency, vanilla JavaScript engine to drive the user's focus across the page.
90
+
-[Shepherd](https://github.com/shepherd-pro/shepherd) - Guide your users through a tour of your app.
91
+
85
92
#### Others
86
93
87
94
-[Installation template](https://gitlab.com/tgdp/templates/-/blob/main/installation-guide/template-installation-guide.md) - Open-source template provided by The Good Docs Project.
88
95
-[Troubleshooting template](https://gitlab.com/tgdp/templates/-/tree/main/troubleshooting) - Open-source template provided by The Good Docs Project.
89
96
-[Terminology system guide template](https://gitlab.com/tgdp/templates/-/blob/main/terminology-system/guide-terminology-system.md) - Open-source template provided by The Good Docs Project.
90
97
-[Release Notes template](https://gitlab.com/tgdp/templates/-/blob/main/release-notes/template-release-notes.md) - Open-source template provided by The Good Docs Project.
91
98
-[The Power of Empathy in Support Documentation: A 5-Step Guide](https://www.writethedocs.org/videos/prague/2019/the-power-of-empathy-in-support-documentation-a-5-step-guide-plamena-maleva/) - Apply empathy and iteration to customer support documentation projects.
92
-
- In-App Documentation - Wizards, tooltips, etc.
93
99
94
100
### Architectural Documentation
95
101
@@ -123,6 +129,7 @@ API is the univesal language of the software world, which needs to be documented
123
129
124
130
-[API Reference template](https://gitlab.com/tgdp/templates/-/blob/main/api-reference/template-api-reference.md) - Open-source template provided by The Good Docs Project.
125
131
-[Slate](https://github.com/slatedocs/slate) - Beautiful static documentation for your API.
-[DevDocs](https://github.com/freeCodeCamp/devdocs) - Combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
127
134
-[Zeal](https://github.com/zealdocs/zeal) - Offline documentation browser inspired by Dash.
128
135
-[apiDoc](https://github.com/apidoc/apidoc) - RESTful web API Documentation Generator.
@@ -135,6 +142,9 @@ API is the univesal language of the software world, which needs to be documented
135
142
-[Swagger Petstore](https://petstore3.swagger.io/) - A sample Pet Store Server based on the OpenAPI 3.0 specification.
136
143
-[Redoc](https://github.com/Redocly/redoc) - An open source tool for generating documentation from OpenAPI (formerly Swagger) definitions.
137
144
-[RapiDoc](https://github.com/rapi-doc/RapiDoc) - WebComponent Custom Element for OpenAPI Spec viewing.
145
+
-[Fern](https://github.com/fern-api/fern) - Generate SDKs and API documentation from OpenAPI definitions.
146
+
-[Elements](https://github.com/stoplightio/elements) - Beautiful API documentation powered by OpenAPI and Markdown.
147
+
-[Scalar](https://github.com/scalar/scalar) - Generate interactive API documentations from Swagger files.
138
148
139
149
#### GraphQL
140
150
@@ -299,6 +309,7 @@ API is the univesal language of the software world, which needs to be documented
299
309
-[Readability checker](https://www.thewriter.com/tools/readability) - Score your writing based on the Flesch reading ease scale, which looks at how long your words and sentences are.
300
310
-[Capitalize My Title](https://capitalizemytitle.com/) - An easy, smart title capitalization tool that uses title capitalization rules published by leading professional organizations to ensure your titles and headlines are capitalized correctly.
301
311
-[CasePolice](https://github.com/antfu/case-police) - Scan all your source files and fix the cases of known names.
312
+
-[Tables Generator](https://www.tablesgenerator.com/) - Generate tables in HTML, Markdown, Latex, MediaWiki, etc.
0 commit comments