Skip to content

[ENGINEERING] Add API documentation for public modules #71

Description

@developerfred

Problem

While lib.rs has documentation, many public modules lack doc comments.

Current State

  • lib.rs - Good documentation with /// comments
  • src/error.rs - Good module documentation
  • Most other modules - Missing //! module-level docs

Recommendation

Add doc comments to:

  • src/package/mod.rs
  • src/events/mod.rs
  • src/logging/mod.rs
  • src/deployment/mod.rs
  • src/compiler/ modules
  • src/runtime/ modules

Documentation Guidelines

//! Package management for Bend-PVM
//!
//! This module provides semantic versioning, dependency resolution,
//! and package registry functionality.

pub use package::{Package, Version, PackageRegistry};

Priority

Medium - Affects API discoverability

Labels

  • engineering
  • documentation
  • help-wanted

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions