docs: Improve and expand project documentation#398
Merged
DarianM merged 17 commits intointerledger:mainfrom Oct 16, 2025
p-retrover:docs/improve-env-vars-guide
Merged
docs: Improve and expand project documentation#398DarianM merged 17 commits intointerledger:mainfrom p-retrover:docs/improve-env-vars-guide
DarianM merged 17 commits intointerledger:mainfrom
p-retrover:docs/improve-env-vars-guide
Conversation
The setup guide for environment variables has been updated to be more clear and beginner-friendly. This commit introduces the following improvements: - Adds a summary table for a quick overview of all variables. - Provides a clear example for creating the `OP_WALLET_ADDRESS`. - Restructures the document to improve scannability and clarity for new contributors.
sidvishnoi
reviewed
Oct 9, 2025
Co-authored-by: Sid Vishnoi <8426945+sidvishnoi@users.noreply.github.com>
- Remove redundant script commands from package READMEs - Clarify that components are used by the frontend for demos - Mention fonts and assets in the cdn README - Remove semicolons from code examples in env-vars.md
…trover/publisher-tools into docs/improve-env-vars-guide
Contributor
Author
|
Please check if all the issues have been resolved. and thank you again for suggestions. |
sidvishnoi
reviewed
Oct 9, 2025
sidvishnoi
reviewed
Oct 9, 2025
sidvishnoi
reviewed
Oct 9, 2025
sidvishnoi
reviewed
Oct 9, 2025
- Update AWS example values to be more realistic - Remove redundant "Required for Dev?" column - Improve descriptions in frontend README
Contributor
Author
|
Implemented suggested changes. |
Contributor
Author
|
implemented the minor changes |
Contributor
Author
|
Hello 👋, just wanted to know can this be merged? If no, would love to get some feedback. |
DarianM
reviewed
Oct 16, 2025
Member
Hi @p-retrover thanks for your time and effort helping out with better docs! I'll approve and merge after a hew additions |
Co-authored-by: darianm <47156919+DarianM@users.noreply.github.com>
Co-authored-by: darianm <47156919+DarianM@users.noreply.github.com>
Co-authored-by: darianm <47156919+DarianM@users.noreply.github.com>
Co-authored-by: darianm <47156919+DarianM@users.noreply.github.com>
Co-authored-by: darianm <47156919+DarianM@users.noreply.github.com>
Co-authored-by: darianm <47156919+DarianM@users.noreply.github.com>
Co-authored-by: darianm <47156919+DarianM@users.noreply.github.com>
Contributor
Author
|
implemented the reviewed changes, please confirm the changes. |
DarianM
approved these changes
Oct 16, 2025
Member
🎉 |
…o docs/improve-env-vars-guide
Contributor
Author
Done 👍 |
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
5 participants
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.
Hi there! This PR is for Hacktoberfest and aims to make the project easier to understand for new contributors by improving existing documentation and adding new README.md files for the core packages.
Summary of Changes:
Improved
docs/env-vars.mdAdded Package-Level READMEs
These changes are all self-contained within documentation files and do not alter any application code. Thank you for your consideration!