orinoco/dump-things-service
orinoco/dump-things-service
Watch
5
0
Fork
You've already forked dump-things-service
 1
Code Issues 38 Pull requests Packages Activity Actions

Consider more structured documentation #214

New issue
Open
opened 2026-06-23 06:32:43 +00:00 by mih · 1 comment
mih commented 2026-06-23 06:32:43 +00:00
Owner
Copy link

ATM all documentation is in a 1000-line README with no table of contents (TOC). This is not very accessible. It is hard to understand what the system components are, what could be configured, and how it should be configured.

IMHO at minimum there should be a TOC. However, I doubt that this will provide a lasting improvement. We can assume the number of backends to increase, the number of API endpoints to increase, and the number of "common" use cases to increase. It might be worth moving to a more suitable documentation framework like sphinx even now.

ATM all documentation is in a 1000-line README with no table of contents (TOC). This is not very accessible. It is hard to understand what the system components are, what could be configured, and how it should be configured. IMHO at minimum there should be a TOC. However, I doubt that this will provide a lasting improvement. We can assume the number of backends to increase, the number of API endpoints to increase, and the number of "common" use cases to increase. It might be worth moving to a more suitable documentation framework like sphinx even now.
cmo commented 2026-06-23 08:19:01 +00:00
Owner
Copy link

That is very true. I will move documentaton to sphinx.

That is very true. I will move documentaton to sphinx.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
better-put
pass-code-check
packaging
improve-load-config
remove_duplication
audit-with-apply-change-set
forgejo-labels
maintenance-command
move-workflow-to-forgejo
classes-in-server-endpoint
redirect-root
linkml-test
issue-175
fix_any_of
forgejo-authsource-caching
issue-168
graphql
6.3.7
6.3.6
6.3.5
6.3.4
6.3.3
6.3.2
6.3.1
6.3.0
6.2.2
6.2.1
6.2.0
6.1.0
6.0.2
6.0.1
6.0.0
5.6.1
5.6.0
5.5.0
5.4.0
5.3.6
5.3.5
5.3.4
5.3.3
5.3.2
5.3.1
5.3.0
5.2.1
5.2.0
5.1.1
5.1.0
5.0.3
5.0.2
5.0.1
5.0.0
4.7.0
4.6.1
4.6.0
4.5.3
4.5.2
4.5.1
4.5.0
4.4.0
4.3.1
4.2.0
4.3.0
4.1.1
4.1.0
4.0.0
3.6.0
3.5.0
3.3.3
3.3.2
3.3.1
3.3.0
3.2.1
3.1.0
3.0.1
3.0.0
2.4.1
2.3.4
2.3.3
2.4.0
2.3.2
2.3.0
2.2.0
2.1.0
2.0.1
2.0.0
1.1.0
1.0.0
0.5.0
0.4.0
0.3.0
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.1
0.1.0
labelless
Labels
Clear labels   
bug
Something isn't working

  
documentation
Improvements or additions to documentation

  
duplicate
This issue or pull request already exists

  
enhancement
New feature or request

  
good first issue
Good for newcomers

  
help wanted
Extra attention is needed

  
invalid
This doesn't seem right

  
question
Further information is requested

  
wontfix
This will not be worked on

No labels
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
2 participants
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
orinoco/dump-things-service#214
No description provided.