docs: restructure README with unified config reference

[fank]

Summary

• Merge duplicated configuration tables (JSON keys in Configuration section, env vars in Docker section) into one unified reference with Setting | Env Var | Description | Default columns
• Add previously missing settings: prefixURL, all path settings (db, data, maps, markers, ammo, fonts, static), all customize.* settings, and conversion.retryFailed
• Fix conversion.batchSize default from 10 to 1 (matches setting.go)
• Reorder sections for newcomers: Installation → Docker → Pelican → Configuration → Large Recording Support
• Move docker run example to top of Docker section
• Add customize block to example setting.json

Test plan

• Read through final README and verify all settings from setting.go are present
• Verify internal anchor links (#volumes) resolve correctly on GitHub
• Confirm Docker section still has volumes, run example, and map tool info

[gemini-code-assist]

Summary of Changes

Hello @fank, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request restructures the README to provide a more unified and comprehensive configuration reference, adds missing settings, corrects a default value, and improves the overall organization and clarity of the documentation. The changes aim to make it easier for new users to set up and configure the OCAP Web server, especially when using Docker.

Highlights

• Unified Configuration Reference: Merged duplicated configuration tables into a single reference with Setting, Env Var, Description, and Default columns.
• Added Missing Settings: Included previously missing settings such as prefixURL, path settings (db, data, maps, etc.), customize.* settings, and conversion.retryFailed.
• Fixed Default Value: Corrected conversion.batchSize default value from 10 to 1 to match setting.go.
• Reordered Sections: Reorganized the README sections for better onboarding: Installation → Docker → Pelican → Configuration → Large Recording Support.
• Enhanced Docker Section: Moved docker run example to the top of the Docker section and added a customize block to the example setting.json.

Changelog

• README.md
  • Restructured the document to improve clarity and organization.
  • Consolidated configuration settings into a unified table.
  • Added missing configuration options and updated default values.
  • Improved the Docker section with examples and volume descriptions.

Activity

• Author fank has made significant documentation updates.
• The PR description includes a test plan to verify the changes.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

The pull request effectively restructures the README to provide a unified configuration reference, which significantly improves clarity and reduces duplication. The addition of previously missing settings and the reordering of sections enhance the document's usability for newcomers. The changes to the setting.json example are also a good addition. I've identified a few areas for improvement regarding consistency and clarity in the documentation, particularly around default values and environment variable descriptions.