Skip to content

Plan for improving Junction's documentation #589

Description

@pradyunsg

I figured it'll be a good idea to have a central location to discuss about the documentation updates I have planned for the project.
The general overview is:

  • Get a basic skeleton of sphinx documentation generation into the source tree.
    • Include the documents from current documentation (and mark them as old)
  • Add "development" section with a "getting started" page
  • Include relevant pages in the generated documentation, with the sources outside the documentation tree (uses the .. include ReST directive)
    • Contributing Guide
    • Code of Conduct
    • more?
  • Make the API documentation clearer and more extensive
  • Add a section for discussing the various functionalities of Junction
    • Step-by-step instructions to do common tasks
    • Provide overview of the UI

The plan is to use Sphinx and ReST for the documentation. I'll add support for Markdown documents to the Sphinx documentation but I won't be writing any new documentation using Markdown.

Feedback is welcome on this plan.

Activity

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

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions