README.md

Tip

🎆 Getting set up

docs/QUICK_START.md

docs/MACVLAN.md

docs/CONFIGURE.md

Detail

Tip

🏗️ Design overview docs/DESIGN.md · docs/DESIGN_REVIEW.md

Tip

🔧 Make targets Run make help for a full list

Makefile · make/

graph LR
    app --> backend

    subgraph api
        backend
    end

Loading

Troubleshooting

Tip

🫠 Assessing damage docs/TROUBLESHOOTING.md

Contributing to the project

Note

🔥 IMPORTANT Before begining,
please review the following

Tip

📖 Project guidelines CONTRIBUTING.md

Tip

📖 Pending tasks TODO.md

Tip

🫡 Documentaiton for deps docs/RESOURCES.md

---

Note

🌸 Keeping Cozy Once you're contributing,
please Update the following

Tip

📖 Credit yourself AUTHORS.md