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: Structure refactor #221

Closed
critesjosh opened this issue Apr 16, 2024 · 3 comments
Closed

Docs: Structure refactor #221

critesjosh opened this issue Apr 16, 2024 · 3 comments
Assignees

Comments

@critesjosh
Copy link
Collaborator

critesjosh commented Apr 16, 2024

Consider removing the "Learn" section altogether (or maybe big parts of it). Since the protocol specs have been published, those pages should be considered the source of truth for the associated information. (e.g. reviewing the info on Trees, there are some discrepencies)

@critesjosh
Copy link
Collaborator Author

@signorecello from what i understand, this is going to be started after the DEX alpha build wraps up, correct?

@critesjosh
Copy link
Collaborator Author

As part of the refactor, keep in mind the developer learning journey, related to #142

Maybe we end up creating a new page that guides a new reader through the documentation

@signorecello
Copy link
Collaborator

signorecello commented May 9, 2024

This is mostly being done in AztecProtocol/aztec-packages#6195.

Some things to improve for a stacked PR, or for creating an issue for later:

  • Improve frontmatter, most pages don't even have it and it's crucial for SEO
  • Move guides out of reference, further separate tutorials from guides and etc
  • Remove stuff, remove remove remove

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants