Migrate the Monkey365 documentation site from Material for MkDocs to Zensical

Đang mở
  • Có gì không ổn?
#184 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
30/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Lĩnh vực
documentation

Hướng nghiên cứu

Start with the current Monkey365 documentation site and the linked Zensical reference, then inspect the repository's existing documentation configuration and navigation. Done means the site runs on Zensical, its structure is redesigned, and the proposed architecture, collector, rule, ruleset, and contributor topics are documented with build and link validation.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation enhancement epic priority-medium

Summary

Migrate the Monkey365 documentation site from Material for MkDocs to Zensical and use the migration as an opportunity to redesign and significantly expand the project documentation.

Material for MkDocs is now in maintenance mode, with development focused on Zensical. Although critical fixes and security updates will continue for a limited period, no new features are expected to be added to Material for MkDocs.

Motivation

The current documentation provides a good introduction to installing, configuring, and running Monkey365. However, many of the project's most powerful capabilities and internal concepts are not documented yet.

Migrating the documentation platform would be a good opportunity to:

  • Redesign the documentation structure and navigation.
  • Improve the contributor and authoring experience.
  • Document Monkey365's architecture and internal workflows.
  • Make advanced customisation and extension points easier to understand.
  • Help users and contributors realise the full potential of Monkey365.

Proposed documentation areas

The redesigned documentation could include dedicated sections for the following topics.

Architecture and core internals
  • High-level architecture.
  • Execution lifecycle.
  • Module and component responsibilities.
  • Authentication and connection management.
  • Internal data flow.
  • Error handling, logging, retries, and throttling.
  • Report generation pipeline.
Collectors
  • Collector lifecycle.
  • Collector structure and conventions.
  • Supported data sources.
  • How collectors are discovered and executed.
  • Creating a custom collector.
  • Collector configuration.
  • Collector output contracts.
Collector helpers
  • Available helper functions.
  • Authentication and API request helpers.
  • Pagination and retry helpers.
  • Logging helpers.
  • Error-handling conventions.
  • Performance considerations.
  • Examples of using helpers in custom collectors.
Data normalisation and aggregation
  • Normalised object structure.
  • Provider-specific transformations.
  • Type and property conventions.
  • How normalised and aggregated data is consumed by rules and reports.
Declarative rules
  • Rule schema and supported properties.
  • Rule metadata.
  • Query and condition syntax.
  • Evidence generation.
  • Severity and classification.
  • Creating and validating a custom rule.
  • Complete rule examples.
Rule evaluation
  • Rule discovery and loading.
  • Evaluation lifecycle.
  • How collected data is selected.
  • Query execution.
  • Pass and fail error states.
  • Evidence construction.
  • Debugging rule evaluation.
Rulesets
  • Ruleset structure.
  • Rule selection and grouping.
  • Creating organisation-specific rulesets.
  • Versioning and maintaining rulesets.
  • Sharing reusable rulesets.
Contributor documentation
  • Documentation development environment.
  • Documentation style guide.
  • Contribution workflow.
  • Adding new pages and navigation entries.
  • Link, formatting, and build validation.

References

Ngôn ngữ chính
PowerShell
Star
1.4k
Fork
144
Merge trung bình
1 ngày 21 giờ
Pull request đã merge (30 ngày)
1

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của silverhack/monkey365

Tất cả issue của silverhack/monkey365

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.