update docs #4
Merged
update docs #4
Conversation
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
Updates the project to use YA_CORPS_PORT environment variable instead of PORT. This ensures consistency with the project's naming convention. Adds a detailed README to explain project setup, usage, and API reference. Includes a GIF and charts to make it more appealing. Removes the old .env.example file and creates a new one with the YA_CORPS_PORT variable.
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 pull request updates the environment variable naming for the server port and refactors the documentation for improved clarity and user experience. The most important changes are grouped below:
Configuration and environment variable changes:
PORTtoYA_CORPS_PORTin both.env.exampleandindex.jsto provide a more descriptive and project-specific configuration. [1] [2]Documentation and README improvements:
README.mdto use collapsible<details>sections for each major topic, making the documentation easier to navigate and less overwhelming for new users. [1] [2] [3] [4]YA_CORPS_PORTenvironment variable, ensuring consistency with the codebase.