Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

0.38.0 #735

Apr 16, 2022 · 2 comments · 6 replies
Discussion options

What's Changed

Full Changelog: 0.37.2...0.38.0


This discussion was created from the release 0.38.0.
You must be logged in to vote

Replies: 2 comments 6 replies

Comment options

rmorshea
Apr 16, 2022
Maintainer Author

@acivitillo @Archmonger, outside of critical bug-fixes that arise in the next week, this is the last release before my vacation.

You must be logged in to vote
2 replies
Comment options

Can we push out a Django-IDOM version bump before your vacation?

Comment options

rmorshea Apr 16, 2022
Maintainer Author

Sure.

Comment options

we will build on top of the current version and will contribute on some documentation to idom

You must be logged in to vote
4 replies
Comment options

Feel free to request for my review on any docs.

Comment options

rmorshea Apr 16, 2022
Maintainer Author

@acivitillo all the documentation I've been writing has been closely following the new ReactJS docs (https://beta.reactjs.org/) in structure and content. The documentation they're creating there is absolutely incredible and because they're using a creative commons license we can copy text and examples directly where applicable. While writing IDOM's current documentation was a momentous effort (3 months), I have to imagine it would have taken a year or more without the ability to copy and take inspiration from React's docs.

When you contribute documentation, it would be ideal if you could first take a look at beta.reactjs.org to see if there's a section of documentation they've already written on the subject. If there is, just take that section and regurgitate it in a form that applies to IDOM. Obviously you should feel free to improve on what React has done, but copying examples and the structure of the docs has really sped things up for me. An example of a section I think I was able to improve was Introduction to use_state vs ReactJS's Anatomy of useState

Comment options

Ok will follow react docs for standard documentation. However, there are patterns I need documented and I am happy to contribute them back to idom if it helps. To give you am example, it took a while to figure out the best way to auth with idom is via embedded app, also the pattern of pages as apps is another one that needs research and when best practices are established documentation. Currently I am thinking on writing a tutotial on how to auth with fastapi using a github idp and passing current_user to embedded idom.

Comment options

We are going to be reworking how IDOM is used in production when resolving this issue:

IDOM will primarily exist as an embeddable template tag, identical to Django IDOM. The docs will be refactored to push this narrative. So hopefully, this change on it's own will make it easier to understand how/when to integrate with frameworks.

I don't know if extremely specialized tutorials, like FastAPI authentication, belong in our core docs. I think it's good for us to have some degree tutorials, but the core docs would get flooded if we started hosting things like that. Maybe we should consider some kind of wiki-like structure for this.

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

AltStyle によって変換されたページ (->オリジナル) /