Docs Site
The Docs Site is used to host ZopToken's long-form explanatory content.
Compared to the Website, the Docs Site focuses more on operational procedures, feature boundaries, and troubleshooting.
Docs Site Goals
The documentation site needs to answer:
- How to onboard devices
- How to use Group Key
- How to install the macOS App
- What device statuses mean
- What task statuses mean
- How to understand earnings
- How to handle errors
- How providers can onboard
- What SDK Key is used for
Content Principles
The documentation site should remain:
- Clear
- Restrained
- Actionable
- Easy to update
- Free of over-promises
- Not confusing current capabilities with future plans
Recommended Maintenance Approach
It is recommended that all documentation be managed in Markdown and versioned alongside the code repository.
When platform rules change, the following should be updated with priority:
- FAQ
- Earnings explanation
- Onboarding process
- Key usage instructions
- Troubleshooting
- Version changelog