Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

XS✔ ◾ Updating recommended option #9772

Merged
merged 5 commits into from
Jan 16, 2025
Merged

XS✔ ◾ Updating recommended option #9772

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6b1c326
Update rule.md
sethdaily Jan 16, 2025
8ed10d2
Update rule.md
sethdaily Jan 16, 2025
888e5a5
Update rules/end-user-documentation/rule.md
sethdaily Jan 16, 2025
1f6b107
Update rule.md
sethdaily Jan 16, 2025
d531e7f
Auto-fix Markdown files
github-actions[bot] Jan 16, 2025
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
28 changes: 22 additions & 6 deletions rules/end-user-documentation/rule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,11 @@ redirects:
- do-you-produce-the-best-end-user-documentation
---

`youtube: https://www.youtube.com/embed/yfbKXqRAgOA`

<!--endintro-->

## Developer Documentation

Developer documentation is stored close to the code. Examples are GitHub wiki and Azure DevOps wiki.
Developer documentation is stored close to the code. Examples are GitHub wiki and Azure DevOps wiki. What about end user documentation?

<!--endintro-->

## End-User Documentation

Expand Down Expand Up @@ -98,7 +96,7 @@ Developer documentation is stored close to the code. Examples are GitHub wiki an
* Solo maintainer
* Clunky menu system

### Option 5: Docusaurus (recommended)
### Option 5: Docusaurus

[docusaurus.io](https://docusaurus.io/)

Expand All @@ -119,3 +117,21 @@ Developer documentation is stored close to the code. Examples are GitHub wiki an
❌ **Cons:**

* Need to self-host

### Option 6: TinaCMS (recommended)

✅ **Pros:**

* Content - Supports Markdown
* Editing - user-friendly WYSIWYG editor
* Copying Code - Supports easy copying and pasting of code elements
* Customization - Freedom to build custom React components
* Seamless with GitHub - Allows for pull requrests and suggestions
* Internationalization (i18n) support
* Pricing - Free for small projects and flexible pricing for larger ones
* Hosting - free to choose - no lock in
* Works with Docusaurus

❌ **Cons:**

Developer investment - You get the best experience by taking the time to develop custom components