Open
Conversation
vanodevium
commented
Oct 2, 2024
vanodevium
commented
This was referenced Dec 9, 2025
nekrich
pushed a commit
to nekrich/ofelia
that referenced
this pull request
Feb 13, 2026
…adros#301) ## Summary - Add Documentation section to Table of Contents - Add documentation links after Features section pointing to CONFIGURATION.md and jobs.md - Add configuration reference link after Environment variables table - Add comprehensive Documentation section with table linking to all docs ## Changes The README now links to detailed documentation for deeper explanations: | Document | Description | |----------|-------------| | [Configuration Reference](docs/CONFIGURATION.md) | Complete guide to all configuration options | | [Job Types](docs/jobs.md) | Detailed documentation for each job type | | [Architecture Overview](docs/architecture.md) | System design and component interactions | | [Security Guide](docs/SECURITY.md) | Security best practices and hardening | | [API Reference](docs/API.md) | Web UI API endpoints | | [Troubleshooting](docs/TROUBLESHOOTING.md) | Common issues and solutions | | [Development Guide](docs/DEVELOPMENT.md) | Contributing and local development | | [Quick Reference](docs/QUICK_REFERENCE.md) | Cheat sheet for common configurations | ## Test plan - [ ] Verify all documentation links resolve correctly - [ ] Check README renders properly on GitHub
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.