eMule Documentation Index

This directory is the single Markdown home for the tooling repo. Use DOCS-POLICY for ownership rules.

Start Here

Need	Primary Doc
Workspace policy	WORKSPACE-POLICY
AI contributor repeatability checklist	reference/AGENT-CHECKLIST
Workspace repository map	reference/WORKSPACE-REPO-MAP
Active backlog and RC release status	active/INDEX
Repeatable backlog process	reference/BACKLOG-PROCESS
Evidence retention policy	reference/EVIDENCE-RETENTION
Documentation ownership rules	DOCS-POLICY
Browser-formatted documentation	MkDocs site
Historical-reference rules	HISTORICAL-REFERENCES
Repo-level navigation	GitHub README

If a status claim outside docs/active/ conflicts with docs/active/, treat docs/active/ as authoritative for current local backlog and release state. For GitHub-primary backlog items marked workflow: github, the linked emulebb/emulebb issue and the public eMuleBB Roadmap org Project #2 are authoritative for workflow state. Canonical workflow endpoints are https://github.com/emulebb/emulebb/issues and https://github.com/orgs/emulebb/projects/2.

Active Work

Document	Description
active/INDEX	Active backlog dashboard and item tables
active/FUTURE-ROADMAP	GitHub-primary post-0.7.3 future roadmap
active/plans/P2P-OVERLORD-PRODUCT-FAMILY-INTEGRATION	Post-0.7.3 p2p-overlord product-family integration plan
active/RELEASE-0.7.3	RC release control document
active/RELEASE-0.7.3-CHECKLIST	RC release operator checklist
active/RELEASE-0.7.3-RUNBOOK	RC release operator runbook
active/plans/RELEASE-0.7.3-EXECUTION-PLAN	Current RC release execution plan
active/items/	Active item records for Open, In Progress, Blocked, and Deferred work
history/items/	Closed item records
history/reviews/	Dated revalidation reviews
history/audits/	Historical broad audit reports
history/release-0.7.3/	Superseded beta gate evidence, release audit snapshots, and old cluster plans

GitHub-primary roadmap-backed backlog helper scripts live under scripts/:

• github-roadmap-sync.py previews or applies the roadmap-backed backlog import to emulebb/emulebb issues and the eMuleBB Roadmap Project #2.
• github-roadmap-check.py validates local GitHub metadata, and can query GitHub when run with --github.

Reference Families

Folder	Role
dependencies/	Current dependency health and decision records
history/	Closed item records, dated reviews, historical comparisons, source salvage, and old ledgers
ideas/	Exploratory proposals only, not active implementation plans
reference/	Current product guides and durable specialist references
rest/	REST contract and API reference

Common References

• reference/AGENT-CHECKLIST

• Description: Repeatable operating checklist for AI agents contributing to the workspace

• reference/WORKSPACE-REPO-MAP

• Description: Canonical repository roles, branches, validation commands, and product-family boundaries

• reference/GUIDE-EMULEBB

• Description: eMuleBB product manual entry point, setup, tools, diagnostics, and compatibility

• reference/BACKLOG-PROCESS

• Description: Repeatable workflow for creating, updating, validating, and closing backlog records

• reference/EVIDENCE-RETENTION

• Description: Generated evidence retention tiers, promotion rules, and cleanup policy

• reference/CI-BASELINE

• Description: Reusable CI baseline workflow contract

• reference/DEVELOPMENT-GUIDE

• Description: Development, validation, CI, packaging, command-line, and recurring guide refresh workflow

• reference/RELEASE-BRANCHING-AND-PACKAGING

• Description: Official release branch, tag, version, and portable package naming policy

• reference/GUIDE-SETUP

• Description: Install model, first-run profile behavior, release-aware setup, and evidence links

• reference/GUIDE-NETWORK

• Description: eD2K, Kad, binding, ports, UPnP, firewall, and REST listener basics

• reference/GUIDE-SHARING

• Description: Shared directories, monitored shares, large libraries, and share-ignore policy

• reference/GUIDE-DOWNLOADS-SEARCH

• Description: Downloads, search, categories, broadband upload policy, modern limits, and copy workflows

• reference/GUIDE-PREFERENCES

• Description: Single preference manual: preferences.ini, compatibility, defaults/ranges, schema coverage, and REST mutation

• reference/GUIDE-PERSISTENCE-FILES

• Description: Runtime .met and .dat file roles, structure, editability, backup importance, and recovery notes

• reference/GUIDE-CONTROLLERS-REST

• Description: REST, aMuTorrent, Arr, qBit, and Torznab controller guidance

• reference/ED2K-PROJECT-INVENTORY

• Description: eD2K/eMule ecosystem inventory, including ED2K servers, server lists, clients, controllers, libraries, and historical mods

• reference/GUIDE-IP-FILTERS

• Description: IP filter storage, seeded URLs, formats, and practical use

• reference/GUIDE-LONGPATHS

• Description: Long-path product behavior, setup, limits, and troubleshooting

• reference/KEYBOARD-SHORTCUTS

• Description: Main shell and list keyboard shortcut reference

• reference/GUIDE-TROUBLESHOOTING

• Description: Symptom-led diagnostics, support evidence, and testing/performance context

• dependencies/DEP-STATUS

• Description: Current third-party dependency decision record

• rest/REST-API-ADAPTERS

• Description: Adapter-specific REST, qBit, Torznab, Arr, and aMuTorrent contract notes

• rest/REST-API-CONTRACT

• Description: Human-readable broadband REST contract

• rest/REST-API-OPENAPI

• Description: Canonical machine-readable /api/v1 OpenAPI contract

• rest/REST-API-PARITY-INVENTORY

• Description: Completed REST/WebServer action parity ledger

Browser Site

This Markdown tree can be rendered with MkDocs Material:

python -m pip install -r requirements-docs.txt
python -m mkdocs serve

Use python -m mkdocs build --strict for CI-equivalent local validation. The Material theme emits a current MkDocs 2.0 compatibility notice as a warning, so set $env:NO_MKDOCS_2_WARNING='1' before strict local builds. The generated HTML is written to .local/mkdocs-site and deployed to GitHub Pages by .github/workflows/docs-site.yml on main at https://emulebb.github.io/emulebb-tooling/.

Exploratory Ideas

• ideas/IDEA-AMULE-WATCHLIST

• Description: Exploratory aMule reference watchlist; not an active plan

• ideas/IDEA-MODERNIZATION-2026

• Description: Historical modernization roadmap idea; not an active plan

• ideas/IDEA-IPV6-KAD-NETWORK

• Description: Exploratory IPv6-native Kad network design inspired by qBittorrent/libtorrent dual-stack DHT state separation; not an active plan

• ideas/IDEA-RESTRUCTURE

• Description: Exploratory source-structure idea; not an active plan

Abandoned Ideas

Document	Description
history/ideas/IDEA-BOOST	Abandoned Boost/POCO adoption exploration; provenance only
history/ideas/IDEA-CMAKE	Abandoned CMake/Ninja/vcpkg adoption exploration; provenance only

Notes

• Historical branch names such as stale-v0.72a-experimental-clean and old branch labels may appear in reference docs as provenance only.
• Preserve commit ids and historical branch names where they add provenance, but do not treat them as current-branch guidance unless docs/active/ explicitly says the work is landed on main.