grabowski
c86266fd38
- Add DS_ prefix for datasheets - automatically moved to docs/datasheets/ - Add IMG_ prefix for images - automatically moved to docs/images/ - Update FILE-NAMING-AND-VERSIONING.md with CI auto-sort prefix examples - Create comprehensive docs/datasheets/README.md with CI auto-sort documentation - Create comprehensive docs/images/README.md with CI auto-sort documentation - Add ci/auto-sort-files.yml GitHub Actions workflow for automatic file organization - Update ci/README.md with complete auto-sort system documentation - Update main README.md to reference CI auto-sort system - Enable users to upload files anywhere with correct prefix for automatic organization - Support multiple file types: PDF, DOC, PNG, JPG, SVG, etc. - Provide complete CI workflow with commit automation and error handling
/docs
Project documentation for your KiCad project.
Purpose
This directory contains all project documentation including user manuals, design notes, images, and reference materials.
Directory Structure
images/- Documentation images, photos, and diagramsdatasheets/- Component datasheets and specificationsuser-manual/- End-user documentation and guidesdesign-notes/- Design decisions and technical documentation
Documentation Types
- User Manual: How to use the finished product
- Design Notes: Technical decisions and rationale
- Assembly Guide: How to build the project
- Testing Procedures: Verification and validation
- Troubleshooting: Common issues and solutions
Best Practices
- Use clear, descriptive filenames
- Include version information in documents
- Keep images organized and properly referenced
- Document design decisions and trade-offs
- Update documentation with design changes
- Use consistent formatting and style
File Formats
- Markdown (
.md): Preferred for text documentation - PDF (
.pdf): For formal documents and printable guides - Images: PNG for diagrams, JPG for photos
- Datasheets: PDF format from manufacturers