-
Notifications
You must be signed in to change notification settings - Fork 405
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Automating config/API/CLI documentation #267
Labels
dif/hard
Having worked on the specific codebase is important
effort/weeks
Estimated to take multiple weeks
kind/enhancement
A net-new feature or an improvement to an existing feature
P1
High: Likely tackled by core team if no one steps up
status/ready
Ready to be worked
topic/design-ux
UX strategy, research, not solely visual design
topic/docs
Documentation
topic/infra
Infrastructure
Comments
jessicaschilling
changed the title
Automate API and CLI documentation.
Create roadmap for improving and automating API/CLI documentation
Dec 17, 2019
johnnymatthews
added
dif/hard
Having worked on the specific codebase is important
effort/weeks
Estimated to take multiple weeks
kind/enhancement
A net-new feature or an improvement to an existing feature
need/analysis
Needs further analysis before proceeding
P3
Low: Not priority right now
status/inactive
No significant work in the previous month
topic/design-ux
UX strategy, research, not solely visual design
topic/docs
Documentation
topic/infra
Infrastructure
and removed
need/triage
Needs initial labeling and prioritization
labels
Jun 17, 2020
johnnymatthews
changed the title
Create roadmap for improving and automating API/CLI documentation
Create roadmap for improving and automating API/CLI documentation.
Jun 17, 2020
lidel
changed the title
Create roadmap for improving and automating API/CLI documentation.
Automating config/API/CLI documentation
Sep 2, 2021
I've marked low-hanging fruits with 💢 – those are go-ipfs specific things we could automate in a fashion similar to what we do in https://github.com/ipfs/npm-go-ipfs:
|
lidel
added
P1
High: Likely tackled by core team if no one steps up
status/ready
Ready to be worked
and removed
P3
Low: Not priority right now
status/inactive
No significant work in the previous month
need/analysis
Needs further analysis before proceeding
labels
Sep 2, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
dif/hard
Having worked on the specific codebase is important
effort/weeks
Estimated to take multiple weeks
kind/enhancement
A net-new feature or an improvement to an existing feature
P1
High: Likely tackled by core team if no one steps up
status/ready
Ready to be worked
topic/design-ux
UX strategy, research, not solely visual design
topic/docs
Documentation
topic/infra
Infrastructure
Note: This issue was opened as a result of the November 2019 close-reading audit captured in ipfs-inactive/docs#326.
This issue is one of the prioritized recommendations in the Q1 2020 IPFS Ecosystem Audit for execution in Q2/Q3 2020. Tagging it with
$auditrecommendation
means it's searchable! See all tagged issues in this repo.In brief
Manually editing documentation that can be automated is an excellent way to create un-usable API docs and undocumented endpoints. Things get missed, misrepresented, and misunderstood. If we can find a way to automate the docs for all our APIs we can vastly improve the lives of IPFS devs and users.
What's needed
Find open-source, future-proof ways to (:anger: – biggest pain, easy to automate):
.md
docs in js-ipfs repo)Deliverable
A report and roadmap for improving/automating API/CLI docs, including a platform decision (based on competitive analysis and best-in-breed research) and step-by-step timeline for implementation.
Additional notes/requirements
Note: These have been consolidated from a variety of legacy issues (#69, ipfs-inactive/docs#225, ipfs-inactive/docs#227, ipfs-inactive/docs#339, ipfs-inactive/docs#340) in order to reduce inefficiency.
make
in this repo and regenerate all documentation, including the CLI documentation.)The text was updated successfully, but these errors were encountered: