diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index fc090fc..6aaaf66 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -7,5 +7,5 @@ - [Variables](./concepts/variables.md) - [Data Types](./concepts/datatypes.md) - [Developer Resources](./developers/SUMMARY.md) - - [Backends](./developers/backends.md) - [Contributing to Sabre](./developers/contributing.md) + - [Compiler Backends](./developers/backends.md) diff --git a/docs/developers/contributing.md b/docs/developers/contributing.md index e735cc4..787f128 100644 --- a/docs/developers/contributing.md +++ b/docs/developers/contributing.md @@ -12,6 +12,10 @@ If you want to contribute to the compiler itself, the easiest way to get started You could also run the tests (`cargo test`) and see if any tests are ignored. Usually, if a bug is found in the wild, a failing but ignored test is written, so that it can be further investigated later. +## Writing documentation + +As with all software, Sabre needs good documentation. Since Sabre is still in early development, things change constantly. This means that docs will be out of date in a lot of cases, or not written at all. Any help with the documentation is greatly appreciated! + ## Submitting your code -Development should happen on [SourceHut](https://sr.ht/~garritfra/sabre/). If you want to contribute code, please send a patch to the [public mailing list](https://lists.sr.ht/~garritfra/sabre). If you don't feel confortable with the [patch-based workflow](https://slashdev.space/posts/patch-based-git-workflow) yet, you can also open a pull request in the [GitHub mirror](https://github.com/garritfra/sabre). +Development should happen on [SourceHut](https://sr.ht/~garritfra/sabre/). If you want to contribute code, please send a patch to the [public mailing list](https://lists.sr.ht/~garritfra/sabre). If you don't feel confortable with the [patch-based workflow](https://slashdev.space/posts/patch-based-git-workflow), you can also open a pull request in the [GitHub mirror](https://github.com/garritfra/sabre). Before submitting the code, please make sure that it is **sufficiently documented and tested**.