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.

Sign up for GitHub

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

Jump to bottom

Fix inconsistent section structure/order throughout docsite #829

Closed
martriay opened this issue Nov 26, 2023 · 0 comments · Fixed by #999
Closed

Fix inconsistent section structure/order throughout docsite #829

martriay opened this issue Nov 26, 2023 · 0 comments · Fixed by #999
Assignees
@ericnordelo

Comments

@martriay
Copy link
Contributor

martriay commented Nov 26, 2023 •
edited
Loading

Right now we have this inconsistent section structures throughout the docsite:

Upgrades

  1. explainer
  2. usage

Account

  1. interface

Access

  1. usage
  2. interface

ERC20 and ERC721

  1. interface
  2. compatibility
  3. usage

Security

  1. usage

Introspection

  1. interface
  2. usage

I think we should have

  1. explainer
  2. usage
  3. compatibility

and leave interface for API, of have it between explainer and usage.

@andrew-fleming suggested:

ERC721Component

  • Implementations
    • ERC721Impl
    • ERC721MetadataImpl
      ...
  • ERC721 compatibility
  • Usage
    ...
@martriay martriay mentioned this issue Nov 26, 2023
Merged
@martriay martriay added this to the after milestone Nov 26, 2023
@martriay martriay moved this to 📋 Backlog in Contracts for Cairo Nov 26, 2023
@martriay martriay modified the milestones: after, next Dec 10, 2023
@martriay martriay modified the milestones: next, current, later Jan 26, 2024
@andrew-fleming andrew-fleming modified the milestones: 3. after, 2. next Apr 30, 2024
@ericnordelo ericnordelo self-assigned this May 28, 2024
@ericnordelo ericnordelo moved this from 📋 Backlog to 🏗 In progress in Contracts for Cairo May 28, 2024
@ericnordelo ericnordelo mentioned this issue Jun 4, 2024
Merged
@andrew-fleming andrew-fleming moved this from 🏗 In progress to 👀 In review in Contracts for Cairo Jun 11, 2024
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Resolved in Contracts for Cairo Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ericnordelo ericnordelo

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix docs sections structure inconsistencies ericnordelo/cairo-contracts
3 participants
@martriay @ericnordelo @andrew-fleming