InfiniTimeOrg / InfiniTimeOrg/InfiniTime

Evolution of the documentation

Open
#748 22 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
C
Stars
3.4k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

The documentation (for end-users and for developers) is not well maintained for now. The doc is scattered across multiple pages and places, is probably out of date and not visible enough for the end-users.
I think it would be a good idea to try to update and improve the doc to improve the users and developers experience!

Now, the question is : do we keep the documentation (for developers and/or end-users) in the InfiniTime project or do we host it somewhere else?

  • In another git repo (could be hosted in the InfiniTime organization, of course)
  • In Github wiki/pages
  • On InfiniTime' website (https://infinitime.io), which I unfortunately do not maintain quite well :/
  • anything else?

Splitting the doc from the code would allow to maintain it more easily and to delegate the maintenance to some contributors. But it would have the disadvantage to de-correlate the documentation from versions of InfiniTime. Can we handle that?

So, I open this issue to talk about the documentation : how would you manage the documenation of the project?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inventorying the documentation for end-users and developers across the InfiniTime project and its website. Compare keeping it in the project with a separate repository, GitHub wiki/pages, or the InfiniTime website; done means the project has an agreed documentation location and maintenance approach.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.