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

Integrate elm-docs-preview application documentation #367

Open
ChrisWellsWood opened this issue Aug 16, 2019 · 3 comments
Open

Integrate elm-docs-preview application documentation #367

ChrisWellsWood opened this issue Aug 16, 2019 · 3 comments

Comments

@ChrisWellsWood
Copy link

A new version of elm-docs-preview has recently been released and it adds a cool feature called application documentation, which, as the name suggests, let you build documentation for your application. I've been messing about with this and think that it is really useful. Aside from the obvious benefits of encouraging you to actually document your application, it also enables you to browse the documentation for your dependencies offline. Here's an example that the author made from Richard Feldman's Real World SPA: https://elm-doc-preview.netlify.com/?repo=rlefevre/elm-spa-example

I think this might be the right kind of sensible default to add to create-elm-app, interested to hear what others think.

See this thread on Elm Discourse for more information.

@halfzebra
Copy link
Owner

halfzebra commented Aug 17, 2019

Hi Chris!

I like the idea of introducing this. 👍
Would you like to work on a PR?

@ChrisWellsWood
Copy link
Author

Yes, I will do. I should have some time over the next week.

@halfzebra
Copy link
Owner

Nice, please let me know if you'll need any help!

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

No branches or pull requests

2 participants