dapp-docs: added source code documentation (#438) #439
Conversation
This file contains 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
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
…lder Signed-off-by: Logan Nguyen <[email protected]>
…adients/` folder Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
…` folder Signed-off-by: Logan Nguyen <[email protected]>
…ractions/` folder Signed-off-by: Logan Nguyen <[email protected]>
Signed-off-by: Logan Nguyen <[email protected]>
…e DApp` to main doc README.md Signed-off-by: Logan Nguyen <[email protected]>
quiet-node
added
documentation
Nana-EC
requested review from
ebadiere,
Ivo-Yankov,
stefan-stefanooov,
georgi-l95,
natanasow,
konstantinabl,
AlfredoG87,
shemnon and
lukelee-sl
Nana-EC
previously approved these changes
Oct 11, 2023
Signed-off-by: Logan Nguyen <[email protected]>
mshakeg
pushed a commit
to mshakeg/hedera-smart-contracts
that referenced
this pull request
Oct 14, 2023
…#439) * docs: fixed typo in TEST_SETUP.md Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added Overview to dapp README Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: init source code documentation Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase structure - folder tree document Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `__tests__` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-refactor: moved prerequisite-check into its own folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `prerequisite-check` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `public` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `confile files` Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/api/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/app/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/fonts/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/hooks/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/libs/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/styles/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/sections/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/types/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/utils/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/middleware.md` file Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/activity/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/background-gradients/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/common/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/footer/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/navbar/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/sidebar/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/toast/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/popup-wallet/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/contract-interactions/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-refactor: refactored the source-code-documentation folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added `Tutorials on How to Add a New System Contract to the DApp` to main doc README.md Signed-off-by: Logan Nguyen <[email protected]> * dapp-fix(docs): fixed typo Signed-off-by: Logan Nguyen <[email protected]> --------- Signed-off-by: Logan Nguyen <[email protected]> Signed-off-by: Mo Shaikjee <[email protected]>
ebadiere
pushed a commit
that referenced
this pull request
Oct 16, 2023
* docs: fixed typo in TEST_SETUP.md Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added Overview to dapp README Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: init source code documentation Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase structure - folder tree document Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `__tests__` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-refactor: moved prerequisite-check into its own folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `prerequisite-check` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `public` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `confile files` Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/api/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/app/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/fonts/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/hooks/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/libs/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/styles/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/sections/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/types/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/utils/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/middleware.md` file Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/activity/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/background-gradients/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/common/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/footer/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/navbar/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/sidebar/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/toast/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/popup-wallet/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added codebase walkthrough - `src/components/contract-interactions/` folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-refactor: refactored the source-code-documentation folder Signed-off-by: Logan Nguyen <[email protected]> * dapp-docs: added `Tutorials on How to Add a New System Contract to the DApp` to main doc README.md Signed-off-by: Logan Nguyen <[email protected]> * dapp-fix(docs): fixed typo Signed-off-by: Logan Nguyen <[email protected]> --------- Signed-off-by: Logan Nguyen <[email protected]> Signed-off-by: ebadiere <[email protected]>
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.
Description: This PR added a new source code document which is thorough and meticulous in describing the purposes of each component within the project. Additionally, the document should include a tutorial section that provides guidance on how to integrate new system contracts into the DApp which can be found in the README.md of the source-code-document folder
Related issue(s): #438
Fixes #438
Notes for reviewer:
Checklist