Contributor guide
Monfil is an Electron app written in TypeScript. Start with Getting started to run it and send a pull request.
Find your part of the app
Section titled “Find your part of the app”- Repository map shows where each part lives.
- Main process covers startup, feed work, network access, and window security.
- Renderer covers routes, state, and UI code.
- Electron IPC API describes calls across the process boundary.
- Database covers data ownership, migrations, backups, and recovery.
- Feed sources explains adapters and refresh.
- Feedpacks and OPML follows feed lists into and out of the app.
- Diagnostics shows how to investigate errors.
- Release procedure records the maintainer’s publish steps.
Keep the guide current
Section titled “Keep the guide current”Update documentation in the same pull request as the code it describes. Explain boundaries and reasons that a contributor needs to know. Clean up obsolete claims when you find them.
Edit a page in the contributor guide, preview it with npm --prefix doc run dev, then run npm run lint:docs and npm --prefix doc run build. The site is built and published after the change lands in main.