Skip to content

Evolution of the documentation #748

@JF002

Description

@JF002

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementEnhancement to an existing app/feature

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions