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] core libfuncs - implement the page skeleton #67

Closed
Tracked by #25
remybar opened this issue Feb 26, 2024 · 4 comments · Fixed by #72
Closed
Tracked by #25

[doc] core libfuncs - implement the page skeleton #67

remybar opened this issue Feb 26, 2024 · 4 comments · Fixed by #72
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@remybar
Copy link
Collaborator

remybar commented Feb 26, 2024

parent task: #25

Implement the structure of the core libfuncs documentation page.

@remybar
Copy link
Collaborator Author

remybar commented Feb 26, 2024

@mazurroman could you assign this task to me ?

@mazurroman mazurroman added the documentation Improvements or additions to documentation label Feb 26, 2024
@mazurroman
Copy link
Contributor

@remybar where do you intend to put the content to? On evm.codes it lives on the homepage, but they also only have Solidity & Opcodes.

In Cairo, things are more complicated as we have:

  1. The VM with 4 (only!) opcodes (still TBD to document that in the cairovm.codes app)
  2. CASM with it's own intricacies
  3. Sierra with libfuncs

We could:

  1. Show all of that on the homepage with separate headings
  2. Have dedicated links on the header to separate subpage

For now I suggest to go with 1 and see where that goes. If the page becomes too busy we can split into subpages. Let me know what you think.

@remybar
Copy link
Collaborator Author

remybar commented Feb 26, 2024

@remybar where do you intend to put the content to? On evm.codes it lives on the homepage, but they also only have Solidity & Opcodes.

In Cairo, things are more complicated as we have:

1. The VM with 4 (only!) opcodes (still TBD to document that in the cairovm.codes app)

2. CASM with it's own intricacies

3. Sierra with libfuncs

We could:

1. Show all of that on the homepage with separate headings

2. Have dedicated links on the header to separate subpage

For now I suggest to go with 1 and see where that goes. If the page becomes too busy we can split into subpages. Let me know what you think.

I would prefer the option 1 as they are different topics (VM, CASM and Sierra) and the Sierra libfuncs table will be quite huge, and I would use the playground as the homepage. But It's up to you !

@mazurroman
Copy link
Contributor

@remybar let's go with your suggestion. We can always update later

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
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants