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

doc: Documentation regarding UI #6

Merged
merged 4 commits into from
Aug 7, 2024

Conversation

oceanlvr
Copy link
Contributor

@oceanlvr oceanlvr commented Aug 3, 2024

Expanded how to use and customize templates, which Indirectly explains how to customize components and nextjsapp parts.


fixes #4
fixes #5

Current implementation only makes use of DaisyUI and low level vanilla implementations. This should provide flexibility to install any UI libraries people may want to use. Documentations or FAQ entries can be written to address the question. Suggestions are being made to better support other UI libraries.

We wrote how to customize the toolbox preset components and nextjs app part to explain to users. For the APP part, users can use any UI scheme they need, such as CSS-in-JS \ styling component and so on.

For the component part, we show how to customize the preset component and wrap it to form a new component

@jrcarlos2000 @metalboyrick


the updated code mainly involves:

Support for the debug page component (located in packages/nextjs/app/debug/_components/contract component)
Upgrading dependencies
Upgrading the deploy-contract script
These changes are mostly imperceptible to users, updating the installation section to introduce starting ss2 according to the ss2 readme.md file.

relative issue & bg: #5
relative code: Scaffold-Stark/scaffold-stark-2@v0.1.0...v0.2.2

@oceanlvr oceanlvr force-pushed the dev-oyx branch 2 times, most recently from 31db5a5 to fcf660c Compare August 3, 2024 10:22
Copy link
Collaborator

@metalboyrick metalboyrick left a comment

Choose a reason for hiding this comment

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

Thank you for the PR! I think this is already nice and compact. Just keep in mind that the actual UI-agnostic concept comes from the fact that the user can create a fresh dApp leveraging our strictly typed hooks that can save time. The Debug Contracts page and its components are more of things that is used to render the contract testing UI, not really intended to be used as the UI in the user's dApp (although they can customize it if they want, and nicely indicated in your change)

docs/quick-start/environment.mdx Show resolved Hide resolved
docs/quick-start/customize-your-own-dApp.mdx Outdated Show resolved Hide resolved
docs/quick-start/customize-your-own-dApp.mdx Outdated Show resolved Hide resolved
docs/quick-start/customize-your-own-dApp.mdx Outdated Show resolved Hide resolved
docs/quick-start/customize-your-own-dApp.mdx Outdated Show resolved Hide resolved
docs/quick-start/customize-your-own-dApp.mdx Outdated Show resolved Hide resolved
docs/quick-start/environment.mdx Outdated Show resolved Hide resolved
@oceanlvr
Copy link
Contributor Author

oceanlvr commented Aug 4, 2024

Hello sir. I understand now, including the debug page is only to show the effectiveness of our toolbox to users, not the final dapp.
Thank you for your careful modifications and suggestions. I have written a bit more in response to your feedback and included the latest version of the documentation. PTAL. :)
@metalboyrick

Copy link
Collaborator

@metalboyrick metalboyrick left a comment

Choose a reason for hiding this comment

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

One last detail.

docs/quick-start/customize-your-own-dApp.mdx Outdated Show resolved Hide resolved
@metalboyrick
Copy link
Collaborator

Hello sir. I understand now, including the debug page is only to show the effectiveness of our toolbox to users, not the final dapp. Thank you for your careful modifications and suggestions. I have written a bit more in response to your feedback and included the latest version of the documentation. PTAL. :) @metalboyrick

Not really to show effectiveness, but we want users to easily do basic interactions with their deployed smart contracts within the Debug Contracts page. That's why that page is there

@oceanlvr
Copy link
Contributor Author

oceanlvr commented Aug 5, 2024

Not really to show effectiveness, but we want users to easily do basic interactions with their deployed smart contracts within the Debug Contracts page. That's why that page is there

Got it~ This is a necessary debugging tool for developing dapps

@oceanlvr
Copy link
Contributor Author

oceanlvr commented Aug 6, 2024

the updated code mainly involves:

Support for the debug page component (located in packages/nextjs/app/debug/_components/contract component)
Upgrading dependencies
Upgrading the deploy-contract script
These changes are mostly imperceptible to users, updating the installation section to introduce starting ss2 according to the ss2 readme.md file.


relative issue & bg: #5
relative code: Scaffold-Stark/scaffold-stark-2@v0.1.0...v0.2.2

@jrcarlos2000

@oceanlvr
Copy link
Contributor Author

oceanlvr commented Aug 6, 2024

These changes are mostly imperceptible to users. I have updated the section on how to run and deploy the project, according to the instructions in the install file. Additionally, the git submodule has been removed. For more details, please see the install file.

@0xquantum3labs 0xquantum3labs changed the base branch from main to develop August 7, 2024 07:35
@0xquantum3labs 0xquantum3labs merged commit b395aa8 into Scaffold-Stark:develop Aug 7, 2024
1 check passed
@oceanlvr oceanlvr deleted the dev-oyx branch August 7, 2024 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs with new release Documentation regarding UI libraries
3 participants