View Documentation

Learn how to access KidPix documentation and get help with the application.

Online Documentation

The complete KidPix documentation is available online at:

https://justinpearson.github.io/kidpix/

The documentation includes:

  • User guides for learning how to use KidPix
  • Maintainer guides for developers working on the project
  • Technical explanations about the architecture and design decisions

Documentation Structure

For Users

For Developers

Getting Help

Reporting Issues

If you encounter bugs or problems with KidPix:

  1. Check existing issues at GitHub Issues
  2. Search the documentation to see if your question is already answered
  3. Create a new issue with:
  4. Clear description of the problem
  5. Steps to reproduce the issue
  6. Browser and operating system information
  7. Screenshots if helpful

Feature Requests

To suggest new features or improvements:

  1. Check existing feature requests in GitHub Issues
  2. Create a new issue with the "enhancement" label
  3. Describe your idea including:
  4. What you'd like to see added
  5. Why it would be useful
  6. How you imagine it working

Documentation Issues

Found a problem with the documentation itself?

  1. Documentation issues can be reported at GitHub Issues
  2. Label your issue with "documentation"
  3. Be specific about:
  4. Which page has the problem
  5. What's unclear or incorrect
  6. Suggestions for improvement

Community

  • GitHub Repository: justinpearson/kidpix
  • Live Demo: kidpix.app
  • Issues & Discussions: Use GitHub Issues for bug reports, feature requests, and questions

Offline Access

The documentation is also available in the project repository:

  1. Clone the repository: git clone https://github.com/justinpearson/kidpix.git
  2. Navigate to the doc/ directory
  3. All documentation files are in Markdown format and readable in any text editor