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.

Sign up for GitHub

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

Jump to bottom

Update documentation #138

Open
airidaceae opened this issue Jul 24, 2023 · 2 comments · May be fixed by #283
Open

Update documentation #138

airidaceae opened this issue Jul 24, 2023 · 2 comments · May be fixed by #283
Assignees
@marceline-cramer @airidaceae
Labels
documentation Improvements or additions to documentation
Milestone
MVP documentation

Comments

@airidaceae
Copy link
Collaborator

Hearth has changed a lot in the past few months and the readme and design document are pretty out of date. We should update these to make hearths goals and plans more clear.
@airidaceae airidaceae added the documentation Improvements or additions to documentation label Jul 24, 2023
@marceline-cramer
Copy link
Collaborator

The roadmap and design document both need to be rewritten. We also need to work in kindling into the readme.

@marceline-cramer
Copy link
Collaborator

I think that we should replace this issue with a bunch of individual issues that address individual concerns in the documentation. We'll add it to a milestone instead: https://github.com/hearth-rs/hearth/milestone/2

@airidaceae could we put together a list of specific things that need to be addressed?

@marceline-cramer marceline-cramer added this to the MVP documentation milestone Nov 29, 2023
@marceline-cramer marceline-cramer mentioned this issue Dec 3, 2023
Closed
5 tasks
@marceline-cramer marceline-cramer linked a pull request Jan 13, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@marceline-cramer marceline-cramer

@airidaceae airidaceae

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
MVP documentation
Development

Successfully merging a pull request may close this issue.

New design doc hearth-rs/hearth
Rewrite the design document hearth-rs/hearth
2 participants
@marceline-cramer @airidaceae