Skip to content

Website with docs #1134

Closed
Closed

Description

@1oglop1

This is more a feature request than a problem.

Problem

As a new user, I find it a bit difficult to orient myself in the documentation files.
It would probably be more beneficial to have a static website with docs.
At the moment there are many problems e.g.:

  • index README.md takes the reader to another md and the reader than loses the track of the outline
  • Some pages are not up to date with the code: e.g. config file options page is missing privatePackages

Proposed solution

Delivering a website is relatively simple.
Hosting:

There's no need to change anything about markdown since there are static page generators from markdown.
I find these 2 tools the most popular sphinx and mkDocs
More info and more tools are in this article https://dev.to/mxglt/some-great-tools-to-create-a-static-site-from-your-markdown-documentation-mke.

I come from the Python world where 80% of documentation is generated directly from the code. JS/TS has jsdoc which I really like. And static site generators either have plugins for it or there is another way to generate docs from the code.

Examples:

Activity

  1. brionmario commented on Jan 2, 2024

    @brionmario

    BTW, there's an unofficial site that's built by a community member.

    Although I would also love to have an official documentation site.
    Is anybody working on such a task. I'm willing to contribute :)

  2. tembbo commented on Jul 19, 2024

    @tembbo

    Another option would be cloudflare pages.

  3. Andarist commented on Jul 20, 2024

    @Andarist
    Member

    I'm open to merging a PR that would introduce proper docs here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions