Skip to content

Documentation completeness audit (grouped) #309

@somethingwithproof

Description

@somethingwithproof

Group: README.md completeness

  • Add Compatibility section (Cacti 1.2.14 minimum from INFO)
  • Add Requirements section (PHP version, SNMP, Net_DNS2)
  • Add License reference (LICENSE file exists)
  • Add link to CONTRIBUTING.md
  • Expand Installation with directory rename step
  • Consider Troubleshooting section (link to wiki, known issues)

Group: .github templates

  • Add PULL_REQUEST_TEMPLATE.md (gpsmap has one; mactrack missing)
  • Fix Identifer → Identifier in bug_report
  • Consider PULL_REQUEST_TEMPLATE/bug_fix.md and enhancement.md (optional)

Group: CactiCheatSheet.md

  • Rename or clarify: title "Cacti documentation" is vague; content is Mactrack-specific
  • Consider merging cheat sheet content into README or wiki
  • Fix grammar: "Interface description are" → "Interface descriptions are"

Group: Net/README.md

  • Update PHP requirement (5.4+ is outdated; Cacti requires PHP 7.4+)
  • Add note that this is bundled Net_DNS2; upstream at pear/net_dns2

Group: Other docs

  • Ensure CHANGELOG reflects current develop work
  • CONTRIBUTING: consider adding link to Cacti plugin development docs

Related

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions