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

Documentation improvements #96

Open
drmorr0 opened this issue Feb 29, 2024 · 2 comments · Fixed by #99
Open

Documentation improvements #96

drmorr0 opened this issue Feb 29, 2024 · 2 comments · Fixed by #99
Labels
docs Documentation improvements

Comments

@drmorr0
Copy link
Contributor

drmorr0 commented Feb 29, 2024

Description

We need to improve the documentation to make things easier for new folks. At a minimum, we need

  • Installation page: should cover all the installation options in detail
  • Concepts: talk about what a trace is, intended/suggested workflows, etc
  • Getting Started: how to record a trace and run your first simulation!
  • Advanced topics: autoscaling, ???
  • Maybe an FAQ?

There might be some other pages that we want, too, I'll add more as I think of them.

@drmorr0 drmorr0 added the docs Documentation improvements label Feb 29, 2024
@drmorr0
Copy link
Contributor Author

drmorr0 commented Feb 29, 2024

@BigValen if there are other issues you run into while you're playing around with this that you think would be helpful to add to the docs, feel free to drop a comment here!

@drmorr0
Copy link
Contributor Author

drmorr0 commented Mar 1, 2024

This isn't 100% done, we still need some docs around metrics collection and an FAQ

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

Successfully merging a pull request may close this issue.

1 participant