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

Have an automatically generated documentation #84

Closed
1 task done
kelsos opened this issue Apr 15, 2019 · 5 comments · Fixed by #287
Closed
1 task done

Have an automatically generated documentation #84

kelsos opened this issue Apr 15, 2019 · 5 comments · Fixed by #287

Comments

@kelsos
Copy link
Contributor

kelsos commented Apr 15, 2019

Description

Evaluate if it makes sense to generate documentation from the source code using typedoc.

Acceptance criteria

  • All the SDK naming is renamed to raiden-ts (done Rename folder and imports to raiden-ts #281)
  • Runs automatically as part of a successful CI flow.
  • Gets automatically generated
  • Gets automatically deployed to lightclient.raiden.network/docs
  • Gets hosted
  • Markdown is generated by typedoc
  • Markdown is feed to slate

Tasks

  • Add another step in the CI configuration

Story Points

@christianbrb christianbrb added this to the Backlog milestone Apr 16, 2019
@christianbrb christianbrb changed the title Discuss if it makes sense to have automatically generated documentation Have an automatically generated documentation Apr 16, 2019
@christianbrb
Copy link
Contributor

Could we also use Slate?

@kelsos
Copy link
Contributor Author

kelsos commented May 3, 2019

@christianbrb It might be possible. I did a quick search and there is a typedoc markdown plugin.
So if we configure typedoc to generate markdown then we can feed that to slate. I will need to experiment a little bit to see who everything fits together.

@christianbrb
Copy link
Contributor

If we take Slate -> need to check how we deploy it and where to deploy it
Let's give it a try :-)

@nephix
Copy link
Contributor

nephix commented Aug 22, 2019

I heard someone only having good things to say about https://docsify.js.org which should be pretty straightforward to use as well if typedoc generates markdown

EDIT: https://docute.org as well

@christianbrb christianbrb removed this from the Product Backlog milestone Aug 26, 2019
@kelsos kelsos self-assigned this Aug 26, 2019
@kelsos
Copy link
Contributor Author

kelsos commented Aug 27, 2019

I am going with vuepress since it is already supported by typedoc-plugin-markdown.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants