Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add V3 Technical Architecture and Design doc to the build section #590

Merged
merged 9 commits into from Feb 8, 2024

Conversation

Gunit2481
Copy link
Contributor

No description provided.

@Gunit2481 Gunit2481 added the documentation Improvements or additions to documentation label Jan 26, 2024
@Gunit2481 Gunit2481 requested review from a team as code owners January 26, 2024 17:25
Copy link

github-actions bot commented Jan 26, 2024

Visit the preview URL for this PR (updated for commit e47af35):

https://astar-docs--pr590-ds-v3-technical-desi-t7w43jhd.web.app

(expires Thu, 15 Feb 2024 13:53:56 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: f2f13e9b593d211faae6343d67a88fac3fd7268d

Copy link
Member

@Dinonard Dinonard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reviewd 1/3 of the doc but believe this shouldn't be put into the docs.

I just don't believe the format is good.
The purpose behind the source doc was for me to have a single source of information & decisions we/I made. Sort of a reference for implementation.

Let's consider an alternative approach.
I honestly feel this will bring more confusion than information.

docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
@Dinonard Dinonard requested a review from andabak February 8, 2024 10:15
Copy link
Contributor Author

@Gunit2481 Gunit2481 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've left a few suggestions, but overall, lgtm.

docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
docs/build/dapp-staking/dapp_staking_architecture.md Outdated Show resolved Hide resolved
Dinonard and others added 4 commits February 8, 2024 11:35
Co-authored-by: Gaius_sama <85451570+Gunit2481@users.noreply.github.com>
Co-authored-by: Gaius_sama <85451570+Gunit2481@users.noreply.github.com>
Co-authored-by: Gaius_sama <85451570+Gunit2481@users.noreply.github.com>
---

:::important
The target audience for this page are developers.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The target audience for this page are developers building projects which interact with dApp Staking protocol.

Just a suggestion to clearly drive away those who fall into category /use/for-devs

Copy link
Member

@andabak andabak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a minor nice-to-have comment

@Dinonard Dinonard merged commit ac1064e into main Feb 8, 2024
3 checks passed
@Dinonard Dinonard deleted the DS-V3-Technical-design-doc branch February 8, 2024 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants