jeremy/farm-manager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: README and wiki #16

New Issue
Closed
opened 2026-03-05 18:45:52 -06:00 by jeremy · 0 comments
jeremy commented 2026-03-05 18:45:52 -06:00
Owner
Copy Link
Copy Source

Write the project README and create a Wiki.js page for Farm Manager.

README Tasks

  • Project overview and architecture diagram (ASCII)
  • Component breakdown: Node Agent, API Server, Dashboard
  • Prerequisites and dependencies
  • Development setup instructions (local Docker Compose for all 3 components)
  • Deployment instructions (step-by-step)
  • API reference (endpoint table)
  • Configuration reference (environment variables)
  • Contributing guidelines

Wiki.js Tasks

  • Create page under infrastructure/farm-manager
  • Architecture overview with node diagram
  • Link to Gitea repo
  • Operational runbook: how to add a new node, how to reset groups
  • Troubleshooting section

Notes

  • Wiki.js is at http://192.168.86.100:3002
  • Use the documentation-keeper agent to create the wiki page
  • README should be self-contained enough to on-board a new contributor
Write the project README and create a Wiki.js page for Farm Manager. ## README Tasks - [ ] Project overview and architecture diagram (ASCII) - [ ] Component breakdown: Node Agent, API Server, Dashboard - [ ] Prerequisites and dependencies - [ ] Development setup instructions (local Docker Compose for all 3 components) - [ ] Deployment instructions (step-by-step) - [ ] API reference (endpoint table) - [ ] Configuration reference (environment variables) - [ ] Contributing guidelines ## Wiki.js Tasks - [ ] Create page under infrastructure/farm-manager - [ ] Architecture overview with node diagram - [ ] Link to Gitea repo - [ ] Operational runbook: how to add a new node, how to reset groups - [ ] Troubleshooting section ## Notes - Wiki.js is at http://192.168.86.100:3002 - Use the documentation-keeper agent to create the wiki page - README should be self-contained enough to on-board a new contributor
jeremy added this to the v1.0 milestone 2026-03-05 18:45:52 -06:00
jeremy added the documentation label 2026-03-05 18:45:52 -06:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
documentation
Documentation updates
 feature
New feature or enhancement
 infrastructure
Infrastructure, deployment, and DevOps
 testing
Tests and QA
No Label documentation
Milestone
No items
No Milestone v1.0
Projects
Clear projects
No project
Assignees
Clear assignees
jeremy
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: jeremy/farm-manager#16
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?