AToMPM / AToMPM/atompm

Steps to improve documentation

Open
#120 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
JavaScript
Stars
25
Forks
15
PR merge metrics
No merged PRs in 30d

Description

- [x] Align installation steps in documentation with README.
- Documentation should just point to README file in folder/repo. This prevents duplication of information.
- [x] Add link to source code and issue tracker to first page of documentation
- [ ] Fix up documentation such that JSDoc can extract it
- See [about-getting-started.html](https://jsdoc.app/about-getting-started.html) for basic usage
- See [about-configuring-jsdoc.html](https://jsdoc.app/about-configuring-jsdoc.html) for info about not ignoring files like _worker.js
- See [howto-commonjs-modules.html](https://jsdoc.app/howto-commonjs-modules.html) for info about comments in Node.js modules
- [ ] Investigate possibility of using [sphinx-js](https://hacks.mozilla.org/2017/07/introducing-sphinx-js-a-better-way-to-document-large-javascript-projects/) to extract documentation into online docs
- [ ] Automate this extraction (on ReadTheDocs side)
- [ ] Organize documentation based on principles from [diataxis](https://diataxis.fr/)

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the documentation and README locations, then follow the linked JSDoc guidance for extraction and configuration. Investigate sphinx-js and its ReadTheDocs automation possibility, and use Diátaxis as the organizing reference. Done means the remaining checklist items are addressed and the online documentation workflow is documented or automated.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, tooling
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.