docs: Improve README with Development Setup and Project Structure sections#382
Closed
maojianian25-png wants to merge 1 commit into
Closed
docs: Improve README with Development Setup and Project Structure sections#382maojianian25-png wants to merge 1 commit into
maojianian25-png wants to merge 1 commit into
Conversation
…tions - Added Development Setup section explaining how to serve locally (npx serve .) - Added Project Architecture explanation (static site, no build step) - Added Key Files reference table - Expanded Project Structure to match actual codebase layout - Translated Quick Start section to English (developer-facing README) - Verified all links (Swagger UI, Dev Portal, Chain Explorer) - No new doc files created (README.md only, as required) Codebase verification: marketplace-social.js lives at HTML root (not in js/). Main API file: api-proxy.js. Closes INDIGOAZUL#50
PR Gatekeeper
This PR has been automatically closed. Follow the process in CONTRIBUTING.md and try again. |
4 tasks
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.
Summary
Closes #50
Improved the README.md with better onboarding information for new developers.
Changes
1. Development Setup Section (NEW)
npx serve)npx serve .2. Project Structure Section (IMPROVED)
css/,js/,assets/,chain/,components/,packages/sdk/,translations/,i18n/,.github/3. Quick Start Section (IMPROVED)
Definition of Done
npx serve .)Codebase Verification Answer
Reward tier: Tier 0 (50 LTD)