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

Rework QuickStart documentation #290

Closed
Dref360 opened this issue May 15, 2024 · 3 comments
Closed

Rework QuickStart documentation #290

Dref360 opened this issue May 15, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Dref360
Copy link
Member

Dref360 commented May 15, 2024

We should focus our quick start on the new API. Maybe make 2 version, one for coders one for researcher,

@Dref360 Dref360 added the documentation Improvements or additions to documentation label May 15, 2024
@Dref360
Copy link
Member Author

Dref360 commented May 22, 2024

Some notes that I got from looking at our docs.

  • Getting started is a bit daunting. Should probably get someone ready to do AL in ~5 min. Move the theory to a "Learn" tab along with Research.
  • Our API doc is great, I like the format Example + API
  • I think we could be better with our tutorials. They are a bit all over the place and should be referenced from the home page and the Getting Started
  • The Home page should highlight our News/Wins along with a video of what's Baal is about. Should link to "Getting Started" and basic tutorials.

@Dref360 Dref360 self-assigned this May 22, 2024
@Dref360
Copy link
Member Author

Dref360 commented Jun 3, 2024

Could use this plugin to have cards
https://www.neoteroi.dev/mkdocs-plugins/

@Dref360
Copy link
Member Author

Dref360 commented Jun 6, 2024

Working on it on #296

@Dref360 Dref360 closed this as completed Jun 10, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant