Skip to content

Enhance documentation and setup for gPhoto2 and SD Card Distribution#45

Merged
jairomelo merged 17 commits into
mainfrom
dev
May 31, 2026
Merged

Enhance documentation and setup for gPhoto2 and SD Card Distribution#45
jairomelo merged 17 commits into
mainfrom
dev

Conversation

@jairomelo

Copy link
Copy Markdown
Member

Closes #41 #42 #43

This pull request introduces several improvements focused on documentation, developer experience, and network configuration for the digitization toolkit project. The main highlights are the addition of a detailed changelog, new developer and user documentation (including SD card distribution and camera setup guides), and enhancements to network configuration for easier deployment and access. There are also updates to Docker and environment files to support these changes, and minor improvements to the documentation site's navigation and features.

Documentation and Developer Experience Improvements:

  • Added a comprehensive CHANGELOG.md tracking all notable changes, features, and fixes, following Keep a Changelog format.
  • Introduced new developer documentation, including an SD card distribution guide (docs/developers/sd_card_distribution.qmd) and a gPhoto2 camera setup guide, both linked in the documentation sidebar and navigation. [1] [2] [3] [4] [5]
  • Updated the documentation site to include a "Release History" section in README.md and improved navigation with new sidebar sections and lightbox support for images. [1] [2] [3] [4] [5]

Network Configuration and Deployment:

  • Improved .env.example to clarify usage of HOST_IP, updated PUBLIC_API_BASE to route browser API calls through Nginx, and expanded CORS_ORIGINS for better network discoverability and cross-origin support.
  • Enhanced docker-compose.pi.yml to add an Nginx reverse proxy service (for single-origin access and Chrome PNA policy compliance) and updated frontend environment variables for correct API routing.

Build and Infrastructure:

  • Added a Dockerfile and .dockerignore for building and serving Quarto-based documentation via Nginx, and registered a docs service in docker-compose.yml for local documentation access. [1] [2] [3]

Subproject and Generated Files:

  • Updated the backend subproject commit reference.
  • Regenerated documentation site files to reflect new guides, sidebar structure, and updated publication dates. [1] [2]

These changes collectively make the toolkit easier to deploy, document, and use—especially in multi-device or distributed environments.

jairomelo added 17 commits May 29, 2026 15:38
…dates

- Changed publication date from May 19, 2026 to May 29, 2026 in index.html and related sections.
- Added new "SD Card Distribution" guide to listings.json and search.json.
- Updated search text to reflect the new publication date and added details for the SD Card Distribution guide.
- Enhanced the sidebar navigation in index.html to include the new Software Setup Guides section with the SD Card Distribution link.
- Created a new HTML file detailing the setup process for gPhoto2-compatible cameras, including connection instructions for Raspberry Pi and specific settings for Canon EOS Rebel T7.
- Added a QMD file with the same content for integration into the documentation site.
- Included notes on camera compatibility and precautions regarding auto power off settings.
@jairomelo jairomelo self-assigned this May 31, 2026
@jairomelo jairomelo added the enhancement New feature or request label May 31, 2026
@jairomelo jairomelo merged commit d65dc7c into main May 31, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

image orientation

1 participant