Doc improvements before the NSF project wrap-up #3143
Description
- Scan existing code and see where improvements to code docs are needed:
- Structs / module-level documentation
- public funcs
- deprecated funcs or coding patterns
- Review maintainer documentation:
- instructions for running clippy, miri, etc locally
- instructions for testing specific crates since shadow is slow to build/test (ex:
cd src/lib/foo && cargo test)
- Review existing policies and see if any should be updated for 'maintenance' mode:
- Supported OSes, kernels
- Code review
- Required tests
- Expectations for contributing to Shadow
- When to use which containers where?
- RootedRefCell/RootedRc is faster but requires host
- and we're not sure how much it matters
- Code cleanup
- Remove all codecov stuff
- Pare down ci tests
- Review experimental options and decide if any can become standard
- Removing incremental builds (that rely on docker image, just use container) run_tests workflow: add sccache #3127
- Keep sccache, but write instructions for disabling when it breaks next run_tests workflow: add sccache #3127
- Issue a new Shadow release