search

wasp-lang / wasp

The fastest way to develop full-stack web apps with React & Node.js.
https://wasp-lang.dev
MIT License
12.73k stars 1.13k forks source link

Make sure users can easily discover richer documentation for features in tutorial #2079

Open sodic opened 4 weeks ago

sodic commented 4 weeks ago

A user on Discord didn't realize there was extra documentation on Operations besides the stuff mentioned in the tutorial and Operations/Overview (which is just an introcution).

We should somehow make it obvious that, for more detailed usage instructions, the reader can check out the dedicated docs page.

We've explored some ideas in the Discord chat: https://discord.com/channels/686873244791210014/1246029656147230781/1247146820027551774

Reikon95 commented 4 weeks ago

As discussed on discord I'm happy to give this a go over the next few days and show a potential solution for the docs :)

sodic commented 4 weeks ago

Perfect! Let us know if you need anything :smile:

And thanks for the interest, we truly appreciate it.

Martinsos commented 4 weeks ago

Ideas from Discord:

Yeah I can certainly see this as a potential issue, and would be good to help people avoid it!

Header at each page saying something like "Now we are going to introduce featuer X, for full docs check here" could be good idea, as mentioned above.

Maybe we could also tell them to check the whole docs at the end of the Tutorial if we don't yet, although that is also misable.

Finally, we could, before Tutorial, in Getting Started, have a bit of guide on how we advise they navigate our docs and what can they expect from them (if we don't have this yet).

Just popping different ideas here!