Open
Add bilingual documentation and streamline README#2
Conversation
Co-authored-by: Fab1can <35488206+Fab1can@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add detailed project documentation and simplify README
Add bilingual documentation and streamline README
Mar 8, 2026
Fab1can
marked this pull request as ready for review
April 9, 2026 20:32
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
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.
Project lacked structured documentation; the README was the sole reference for architecture, configuration, API, and deployment details.
Changes
docs/folder — 15 new filesTwo parallel documentation trees under
docs/en/anddocs/it/, each containing:index.mdarchitecture.mdauth-server.mdserver.jswalkthrough — dependencies, OTP logic, middleware, every route with annotated codenginx.mddefault.confannotation, routing table, security notesconfiguration.mdapi.mdcurlexamplesdeployment.mddocs/README.mdacts as a bilingual entry point linking to both trees.Root
README.mdReduced from 123 lines to ~30. Retains only a one-paragraph description, a 4-step quick-start block, prerequisites, and a pointer to
docs/.💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.