Skip to content

Doc improvements before the NSF project wrap-up #3143

Description

@robgjansen
  • 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
  • Issue a new Shadow release

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    Component

    Documentation

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions