feat: Add comprehensive project documentation#35
Merged
Conversation
This commit introduces a new `docs/` directory containing extensive documentation for the Open Translation Engine project. The documentation is structured as follows: - A main `docs/README.md` serves as the table of contents. - Setup and deployment guides for GitHub Codespaces, Docker, and Render have been moved from the main `README.md` into their own files within `docs/`. - Every Artisan command is documented in its own file under `docs/artisan/`, with details on usage, arguments, and examples. - Every web view is documented in its own file under `docs/views/`, explaining its purpose and functionality. - A new guide in `docs/github-pages.md` explains how to set up a GitHub Actions workflow to automatically deploy the documentation to GitHub Pages. This work fulfills the user's request to create full, thorough technical documentation for the project.
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.
This change adds a complete set of technical documentation for the OTE project, covering setup, deployment, all Artisan commands, and all web views. It also includes a guide for deploying the documentation to GitHub Pages.