doc/website-mdbook
2
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions

doc standards doc? #1

New issue
Open
opened 2025-01-11 10:03:00 +00:00 by unusualevent · 0 comments
unusualevent commented 2025-01-11 10:03:00 +00:00
Owner
Copy link
  • always href to docs in settings pages (include summary/details, then a link to learn more)
  • give multiple examples
  • include commands/code
  • more examples than a minimal hello world
  • upgrade plan (e.g. from very old versions)
  • don't use the words "easy", "simple", or "just do x"
  • all docs in one place on an open site
- always href to docs in settings pages (include summary/details, then a link to learn more) - give multiple examples - include commands/code - more examples than a minimal hello world - upgrade plan (e.g. from very old versions) - don't use the words "easy", "simple", or "just do x" - all docs in one place on an open site
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: doc/website-mdbook#1
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?