Project Polish Roadmap
Overview
This roadmap prioritizes projects by market value and effort required to reach "showcase" quality.
Tier 1: Flagship Products
These projects have the highest potential for monetization and portfolio impact.
netapi
Current State: Functional CLI for ISE, pfSense, WLC, Cloudflare, Keycloak
Target State: Polished open-source tool with documentation, tests, packaging
| Task | Description | Priority |
|---|---|---|
Documentation |
Complete CLI reference, tutorials, architecture docs |
P0 |
Testing |
Unit tests, integration tests, CI pipeline |
P0 |
Packaging |
PyPI release, Homebrew formula, AUR package |
P1 |
Error Handling |
Consistent error messages, helpful suggestions |
P1 |
Configuration |
Config file support (~/.netapi/config.yml) |
P2 |
Shell Completions |
Bash, Zsh, Fish completions |
P2 |
Logo/Branding |
Professional logo, README badges |
P3 |
Phase 1: Documentation (Week 1-2)
domus-netapi-docs/
├── cli/
│ ├── ise/ # ISE subcommands
│ ├── pfsense/ # pfSense subcommands
│ ├── wlc/ # WLC subcommands
│ └── cloudflare/ # Cloudflare subcommands
├── tutorials/
│ ├── getting-started.adoc
│ ├── ise-backup-automation.adoc
│ └── multi-vendor-workflows.adoc
└── architecture/
└── design.adoc
Phase 2: Quality (Week 3-4)
tests/ ├── unit/ │ ├── test_ise_client.py │ ├── test_pfsense_client.py │ └── test_config.py ├── integration/ │ └── test_workflows.py └── conftest.py .github/workflows/ ├── test.yml ├── lint.yml └── release.yml
Phase 3: Distribution (Week 5-6)
# PyPI pyproject.toml (modern packaging) python -m build twine upload dist/* # Homebrew homebrew-netapi/Formula/netapi.rb # AUR PKGBUILD
domus-docs (Documentation System)
Current State: Working Antora aggregator with 19 component repos
Target State: Reference implementation for docs-as-code
| Task | Description | Priority |
|---|---|---|
Architecture Doc |
How the system works, how to replicate |
P0 |
Template Repo |
Starter template for new components |
P1 |
CI/CD Guide |
GitHub Actions + Cloudflare Pages setup |
P1 |
Custom UI |
domus-antora-ui polish and documentation |
P2 |
Tier 2: Infrastructure Projects
Tier 3: Learning/Experimental
These show breadth but need less polish:
-
quijote-reader - Spanish learning tool
-
violin-transcriber - Music/AI experiment
-
rust-learning - Language exploration
Project Page Template
Each flagship project needs:
= Project Name
:description: One-line description
== Problem
What problem does this solve?
== Solution
How does it solve it?
== Architecture
image::diagrams/project-architecture.svg[]
== Features
* Feature 1
* Feature 2
== Installation
[source,bash]
\----
pip install netapi
\----
== Quick Start
[source,bash]
\----
netapi ise sessions
\----
== Status
[cols="1,1,1"]
|===
| Component | Status | Notes
| Core
| Stable
| v1.0
| Docs
| In Progress
| 60%
|===
== Links
* GitHub: link
* Documentation: linkSuccess Metrics
| Milestone | Indicator | |-----------|-----------| | Portfolio Ready | 3 flagship projects documented with diagrams | | Open Source Ready | netapi on PyPI with >10 GitHub stars | | Consulting Ready | Client finds you via documentation | | Product Ready | Paying users or sponsors |