Skip to content

Steps to improve documentation #120

@BentleyJOakes

Description

@BentleyJOakes
  • Align installation steps in documentation with README.
    • Documentation should just point to README file in folder/repo. This prevents duplication of information.
  • Add link to source code and issue tracker to first page of documentation
  • Fix up documentation such that JSDoc can extract it
  • Investigate possibility of using sphinx-js to extract documentation into online docs
    • Automate this extraction (on ReadTheDocs side)
  • Organize documentation based on principles from diataxis

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions