Fixing Documentation Shortcomings
splaroche opened this issue · comments
Context
Much of the documentation for developing Serenade is not clear, incomplete, or hard to find. This is a meta ticket to outline the missing sections so we can fix them up. User facing documentation on some features could be part of this issue or a separate one
Goals
Ease of contributing or working on Serenade
List of missing areas
- Building and running Serenade
- Adding new programming language support or updating existing support
- Training language models
always happy to accept documentation improvements—thanks for creating this issue!
just to make sure you've seen what we currently have, from https://github.com/serenadeai/serenade#docs:
- building and running serenade: https://github.com/serenadeai/serenade/blob/master/docs/building.md
- language support: https://github.com/serenadeai/serenade/blob/master/docs/grammars.md
- training models: https://github.com/serenadeai/serenade/blob/master/docs/training-models.md
@tmacwill good to have those links. Do they show up on the website? How would a user best be directed to those pages?
the main repo README links to the docs folder, but am also open adding some individual links to the README or linking to the docs folder from https://serenade.ai/docs/
@tmacwill Thanks, that's where I was looking! This issue came out of some conversations on the serenade discord about developing/running locally, so I created an issue where we can track people's documentation improvements over time. Personally I hit a bit of a problem with setting up on an M1 that I'm working through, and I'll update the build docs with anything I find :)
nice, makes sense! ah yeah, code-engine and speech-engine don't yet have arm64 support, so on an M1 Mac, you'll need to build them using Rosetta2: https://github.com/serenadeai/serenade/blob/master/docs/building.md#system