You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Personally I found the MLX docs a little hard to read and would advice rewriting the explanation (not the inherent content)
Currently its set up as a tutorial series which is fine but isn't really in my opininion how documentation should work. A student should be free to try things for themselves with the docs providing the information on how to use those functions.
(React Router)[https://reactrouterdotcom.fly.dev/] also has a nice way of splitting the docs in half by letting you choose between a tutorial and the complete docs
If this is something you are open for I would love to help and we can bounce ideas back and forth.
After having read docs for close to 5 years I have a sense of what works and what doesn't after also having to write docs for internships and new developers at companies.
Hope to hear from you.
slack: rnijhuis
The text was updated successfully, but these errors were encountered:
RubenNijhuis
changed the title
Documentation writing style suggestions]
Documentation writing style suggestions
Nov 22, 2021
RubenNijhuis
changed the title
Documentation writing style suggestions
MLX documentation writing style suggestions
Mar 16, 2022
Personally I found the MLX docs a little hard to read and would advice rewriting the explanation (not the inherent content)
Currently its set up as a tutorial series which is fine but isn't really in my opininion how documentation should work. A student should be free to try things for themselves with the docs providing the information on how to use those functions.
I'd take an example out of the react docs and compare how their more formal approach can bring a legible explanation to the features. https://reactjs.org/docs/introducing-jsx.html
(React Router)[https://reactrouterdotcom.fly.dev/] also has a nice way of splitting the docs in half by letting you choose between a tutorial and the complete docs
If this is something you are open for I would love to help and we can bounce ideas back and forth.
After having read docs for close to 5 years I have a sense of what works and what doesn't after also having to write docs for internships and new developers at companies.
Hope to hear from you.
slack: rnijhuis
The text was updated successfully, but these errors were encountered: