Skip to content
This repository has been archived by the owner on Jun 2, 2020. It is now read-only.

Automate CLI documentation #227

Closed
Stebalien opened this issue Jul 25, 2019 · 4 comments
Closed

Automate CLI documentation #227

Stebalien opened this issue Jul 25, 2019 · 4 comments
Labels
dif/medium Prior experience is likely helpful effort/weeks Estimated to take multiple weeks topic/design-front-end Front-end implementation of UX/UI work topic/infra Infrastructure

Comments

@Stebalien
Copy link
Contributor

Request: I'd like to be able to run make in this repo and regenerate all documentation, including the CLI documentation. #212 added a script to generate docs but it would be great if:

  1. This could be hooked up to make.
  2. We could update a single version number somewhere to update to a new go/js IPFS release.
@jessicaschilling
Copy link
Contributor

Flagging this as a potential hotfix, though I'm not sure who'd be able to implement this. @cwaring, any thoughts?

@jessicaschilling jessicaschilling changed the title Automate CLI documentation Hotfix: Automate CLI documentation Aug 26, 2019
@jessicaschilling
Copy link
Contributor

Removing from hotfix category, since this is likely a larger effort we want to address as part of the overall docs platform migration.

@jessicaschilling jessicaschilling changed the title Hotfix: Automate CLI documentation Feature: Automate CLI documentation Sep 12, 2019
@jessicaschilling jessicaschilling changed the title Feature: Automate CLI documentation Automate CLI documentation Sep 19, 2019
@jessicaschilling jessicaschilling added topic/design-front-end Front-end implementation of UX/UI work dif/medium Prior experience is likely helpful OKR: Beta Launch effort/weeks Estimated to take multiple weeks labels Sep 19, 2019
@jessicaschilling jessicaschilling mentioned this issue Oct 4, 2019
Closed
@jessicaschilling
Copy link
Contributor

See issue #340 for the other half of this effort: Investigating the best way to get this done in VuePress.

@jessicaschilling
Copy link
Contributor

Closing, since this issue has been consolidated into the overall effort for improving/automating API/CLI documentation in #393. Comments have been migrated there!

@johnnymatthews johnnymatthews mentioned this issue May 22, 2020
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
dif/medium Prior experience is likely helpful effort/weeks Estimated to take multiple weeks topic/design-front-end Front-end implementation of UX/UI work topic/infra Infrastructure
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Stebalien @jessicaschilling