Skip to content
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

Documentation should be built again #157

Closed
jacogr opened this issue Jun 30, 2018 · 3 comments
Closed

Documentation should be built again #157

jacogr opened this issue Jun 30, 2018 · 3 comments

Comments

@jacogr
Copy link
Member

jacogr commented Jun 30, 2018

Currently the generation is not available although the docs are there -

polkadot-js/dev#132

@ltfschoen
Copy link
Contributor

ltfschoen commented Sep 24, 2018

@jacogr What's your preference for generating API docs, which of the following would you prefer?

  1. using typedoc to build docs from ESDoc comments (i.e. PR Add yarn & node to engines #135 that has been merged) OR
  2. creating nested markdown files (see https://github.com/polkadot-js/common/tree/master/packages/util-keyring/docs) OR
  3. adding docs to a Readme file similar to @palanisn's approach navp4l/api@42ca54d in addressing Documentation: Polkadot UI w3f/General-Grants-Program#34 OR
  4. possibly a better way?

@jacogr
Copy link
Member Author

jacogr commented Oct 13, 2018

Luke, sorry, only noticed this question now - I would like to keep things consistent. So what we do on the api repo, that is what we should do here.

@jacogr jacogr closed this as completed in 1fb1f9d Oct 19, 2018
@polkadot{.js} automation moved this from To Do to Done Oct 19, 2018
@polkadot-js-bot
Copy link

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue if you think you have a related problem or query.

@polkadot-js polkadot-js locked as resolved and limited conversation to collaborators Jun 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Development

No branches or pull requests

3 participants