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

docs: refactor documentation website #1470

Merged
merged 1 commit into from
May 17, 2024
Merged

docs: refactor documentation website #1470

merged 1 commit into from
May 17, 2024

Conversation

ctrlc03
Copy link
Collaborator

@ctrlc03 ctrlc03 commented May 16, 2024

Description

Organize in folders various entries to provide better readability.

## Related Issue(s)

fix #1342

Confirmation

Copy link

vercel bot commented May 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
maci-website ✅ Ready (Inspect) Visit Preview May 17, 2024 7:11am

@ctrlc03 ctrlc03 requested a review from aguzmant103 May 16, 2024 14:28
@ctrlc03 ctrlc03 marked this pull request as draft May 16, 2024 14:46
@ctrlc03 ctrlc03 self-assigned this May 16, 2024
@ctrlc03 ctrlc03 added the documentation Improvements or additions to documentation label May 16, 2024
@ctrlc03 ctrlc03 marked this pull request as ready for review May 16, 2024 15:19
@ctrlc03 ctrlc03 mentioned this pull request May 16, 2024
3 tasks
Copy link
Collaborator

@kittybest kittybest left a comment

Choose a reason for hiding this comment

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

do you think we could also add _category_.json to solidity doc and type doc?
else we might put some simple description to the index page, they look so empty now 🤔
.
another question, would you think the quick start and guides part should be put together? since for me, as a new user who just wanna try to run it first, would see the installation page first then the deployment page.

Copy link
Collaborator

@0xmad 0xmad left a comment

Choose a reason for hiding this comment

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

@ctrlc03 thanks!

@ctrlc03
Copy link
Collaborator Author

ctrlc03 commented May 17, 2024

do you think we could also add _category_.json to solidity doc and type doc?

Yes that's very needed, was thinking to do that in another PR if that's ok

another question, would you think the quick start and guides part should be put together?

I see, yea that makes sense. And maybe move the integration doc to the developer specific resources?

docs(structure): refactor website doc to better organize pages
@kittybest
Copy link
Collaborator

do you think we could also add _category_.json to solidity doc and type doc?

Yes that's very needed, was thinking to do that in another PR if that's ok

Yes!

another question, would you think the quick start and guides part should be put together?

I see, yea that makes sense. And maybe move the integration doc to the developer specific resources?

I think the current structure is good!
But where are the solidity-docs and typedoc?

@ctrlc03
Copy link
Collaborator Author

ctrlc03 commented May 17, 2024

do you think we could also add _category_.json to solidity doc and type doc?

Yes that's very needed, was thinking to do that in another PR if that's ok

Yes!

another question, would you think the quick start and guides part should be put together?

I see, yea that makes sense. And maybe move the integration doc to the developer specific resources?

I think the current structure is good! But where are the solidity-docs and typedoc?

they are inside developers-resources/ inside typescript there's the typedoc + cli docs and inside smart-contracts there's solidity docs

@ctrlc03 ctrlc03 merged commit fe45574 into dev May 17, 2024
21 checks passed
@ctrlc03 ctrlc03 deleted the docs/refactor branch May 17, 2024 14:44
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
Status: Done
Development

Successfully merging this pull request may close these issues.

re-organize documentation entries to be more digestible
3 participants