We welcome contributions that improve the clarity, accuracy, and completeness of this documentation.
| Type | Description |
|---|---|
| Bug Fixes | Correct errors, typos, or broken links |
| Clarifications | Improve unclear explanations |
| Examples | Add or improve code examples |
| Updates | Keep content current with latest BrightSign features |
- Fork this repository
- Create a feature branch (
git checkout -b improve-docs) - Make your changes
- Test that all links work and formatting renders correctly
- Submit a pull request
When contributing documentation, please follow these guidelines:
- Clear and concise: Write for developers of all experience levels
- Action-oriented: Focus on what developers can accomplish
- Practical: Include working code examples when possible
- Accurate: Verify all technical information is correct
Code examples should:
- Be complete and runnable
- Include comments explaining key concepts
- Follow BrightSign coding conventions
- Be tested on actual BrightSign hardware when possible
- Documentation Issues: Open a GitHub issue
- Technical Questions: Visit the BrightSign Community
- Official Support: brightsign.biz/support
Brought to Life by BrightSign®
