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

Make tabasco documentation more intuitive and easier to navigate #24

Open
khamusa opened this issue Jan 21, 2025 · 1 comment
Open

Make tabasco documentation more intuitive and easier to navigate #24

khamusa opened this issue Jan 21, 2025 · 1 comment
Labels
📖 documentation Improvements or additions to documentation Developer experience 🆘 help wanted Extra attention is needed

Comments

@khamusa
Copy link
Contributor

khamusa commented Jan 21, 2025

The example-based documentation does not make it easy for someone to get started with using Tabasco.

We have to figure out a more intuitive way to teach people the basics, and likely offer an indexed table of contents for them to quickly navigate to the distinct features we need. It's also very easy to miss the right level of details for things such as the attributes api.

We also need to include some of the rationale around building this framework, most of which started off the original RFC around tabasco within Oyster's private Notion space.

@khamusa khamusa changed the title Documentation improvements Make tabasco documentation more intuitive and easier to navigate Jan 21, 2025
@khamusa
Copy link
Contributor Author

khamusa commented Jan 21, 2025

I feel I'm so contaminated by talking, writing code and docs about Tabasco, that I might be the worst candidate to understand the best way to teach Tabasco to a newcomer. I'd really appreciate if somebody could help devise the structure of our docs.

@khamusa khamusa added 📖 documentation Improvements or additions to documentation 🆘 help wanted Extra attention is needed Developer experience labels Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation Developer experience 🆘 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant