mirror of
https://github.com/nushell/nushell.git
synced 2024-11-25 18:03:51 +01:00
ffb80b8873
This is still work in progress. But let's start somewhere. Goal for this being in the repo is to make sure we update it more frequently than the https://github.com/nushell/nushell.github.io/tree/main/contributor-book - Add folder for in-repo developer documentation - Move PLATFORM_SUPPORT into devdocs - Move our rust style to devdocs - Use nushell code formatting in CONTRIBUTING - Add FAQ file for developers with example questions - Describe error handling best practices
12 lines
498 B
Markdown
12 lines
498 B
Markdown
# Basic developer documentation
|
|
|
|
This is intended to give some immediate guidance to how to navigate the codebase and lives from everyone updating it if you make a design change.
|
|
|
|
A complementary (currently stale) resource has been the [Nushell contributor book](https://www.nushell.sh/contributor-book/), which until further notice contains broader design guidance.
|
|
|
|
## Contents
|
|
|
|
- [Developer FAQ](FAQ.md)
|
|
- [Platform support policy](PLATFORM_SUPPORT.md)
|
|
- [Our Rust style](devdocs/rust_style.md)
|