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 for Docs #72

Open
jd-santos opened this issue Jul 11, 2024 · 4 comments
Open

Feedback for Docs #72

jd-santos opened this issue Jul 11, 2024 · 4 comments

Comments

@jd-santos
Copy link

Hi,
Bruno is awesome and much less overwhelming for newcomers. The docs, however, are a little less beginner-friendly. I understand that these are likely written for folks coming from Postman and covers the differences well, but it's lacking (or I can't easily find) basic introduction to the UI and working mechanics of the application.

Ironically, I've had to reference the Postman docs to have a better understand of what Bruno does. For reference, I'm a PM and not a developer. Still, a lot of us have reason to fiddle with APIs and better onboarding would be a big help!

@bpoulaindev
Copy link

The thing is that everybody wants nice and clean guides but nobody wants to write them 👀

@sikorka
Copy link
Contributor

sikorka commented Jul 19, 2024

I could give you a hand. At least I could fix the mistakes that are there - almost every page has a typo or not working link. Formatting could be better too.

@sikorka
Copy link
Contributor

sikorka commented Jul 23, 2024

@bpoulaindev I added few smaller fixes, pls take a look if it looks ok #87 #84 #83 #82.

@bpoulaindev
Copy link

Thanks for your contribution i'll have a look at the end of my day and see if it builds on vercel; and if CMD+K still works

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants