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

feedback on hidden articles in docs #73

Closed
samuba opened this issue Apr 29, 2023 · 2 comments
Closed

feedback on hidden articles in docs #73

samuba opened this issue Apr 29, 2023 · 2 comments

Comments

@samuba
Copy link
Contributor

samuba commented Apr 29, 2023

Hi again,
when I first found telefunc yesterday I was not sure about it's approach and if it would fit my needs because the start page makes for a good selling pitch but I needed to read through a lot of the docs pages to stitch together how all of this would feel like in actual code, what architectural choices have been made, edge cases, and if the "philosophy" or way telefunc approaches things actually fits my style.
So I was very surprised when I discovered the hidden RPC article which does a good job in explaining most of these things. Im pretty sure my adoption journey would have been smoother if I would have found that article in the beginning.

So I got curious and looked in the docs code to see what else was hidden from sight and discovered the other articles which after reading through them give me more confidence in the whole approach and how the project is steered.
That being said I really do not understand why these articles are hidden. I think hiding them is a unnecessary hurdle to adoption.I would just put them in the left side nav to make them discoverable.

Of course this is all very subjective but I bet there are others like me : )

@samuba samuba changed the title feedback on docs feedback on hidden articles in docs Apr 29, 2023
@brillout
Copy link
Owner

Thanks 💚. It's actually very usefull to have a glimpse of how you (would have liked to) approach Telefunc.

I think you're right.

FYI I used to oversell the theory behind RPC. Having failed to convince folks, I went for a more practical approach. But I think you're right, both the theory and a practical approach are important.

PR welcome to dig out the hidden docs you believe should be exposed — if that's something you'd be up for.

@brillout
Copy link
Owner

Let's track progress on documentation at #104.

@brillout brillout closed this as not planned Won't fix, can't repro, duplicate, stale Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants