Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

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

Supplementary Documentation #2389

Closed
spacejack opened this issue Mar 6, 2019 · 2 comments
Closed

Supplementary Documentation #2389

spacejack opened this issue Mar 6, 2019 · 2 comments
Labels
Area: Documentation For anything dealing mainly with the documentation itself Type: Enhancement For any feature request or suggestion that isn't a bug fix

Comments

@spacejack
Copy link
Contributor

Regarding this repo: https://github.com/spacejack/mithril-docs-ex

This is a collection of additional documentation people might find useful after they go through the current set of docs on the site. These are to expand on topics that require more detail and nuance than you generally allow for in the API docs and could fill a similar role to Leo's old blog.

  • Can we put these under MithrilJS somewhere so we can have long-term URLs?
  • Where should we put them?
  • Any edits or change suggestions welcome.
  • Contributions are always welcome!
  • Suggested additional topics: Look at Leo's blog and update for 1.x+
@dead-claudia dead-claudia added Area: Documentation For anything dealing mainly with the documentation itself Type: Enhancement For any feature request or suggestion that isn't a bug fix labels Mar 6, 2019
@thequailman
Copy link

These are good, though some of them are mostly in the docs these days I think.

For additional topics, as someone who has spent the past year learning Mithril, I would have appreciated documentation that gave examples/how to for these scenarios:

  • Advanced routing for nested templates with an auth check
  • Basic webpack config
  • Centralizing state management, similar to Vuex
  • Drag and drop
  • Having all of the docs use ES6 module syntax 😁
  • Testing/test harnesses and stubs (add more details to ospec and maybe a section on Jest?)

Happy to add these somewhere.

@dead-claudia
Copy link
Member

@thequailman

Having all of the docs use ES6 module syntax 😁

Already being considered separately in #1687 and #2224.

@dead-claudia dead-claudia moved this to Under consideration in Feature requests/Suggestions Sep 2, 2024
@MithrilJS MithrilJS locked and limited conversation to collaborators Sep 2, 2024
@dead-claudia dead-claudia converted this issue into discussion #2933 Sep 2, 2024
@github-project-automation github-project-automation bot moved this from Under consideration to Completed/Declined in Feature requests/Suggestions Sep 2, 2024

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
Area: Documentation For anything dealing mainly with the documentation itself Type: Enhancement For any feature request or suggestion that isn't a bug fix
Projects
Status: Completed/Declined
Development

No branches or pull requests

3 participants