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

New design for docs and developer portal #338

Closed
Tracked by #313
catmcgee opened this issue Aug 5, 2024 · 4 comments
Closed
Tracked by #313

New design for docs and developer portal #338

catmcgee opened this issue Aug 5, 2024 · 4 comments
Assignees

Comments

@catmcgee
Copy link
Collaborator

catmcgee commented Aug 5, 2024

No description provided.

@catmcgee
Copy link
Collaborator Author

catmcgee commented Aug 5, 2024

  • Including general elevation improvements
    • How to use tags
    • How can we improve search
    • Separating some of the eng-written docs into their type (there are often mixes of explanations & howtos)
  • Put a design request through for developer portal

@catmcgee
Copy link
Collaborator Author

catmcgee commented Aug 6, 2024

i sent this over to design
https://docs.google.com/document/d/1tdoU_AA3T_ic_t7bCSbJZ6McLle0Ex7Q-6mOE1vjKpE/edit

This is for docs

Structure

Top level

  • Concepts
    • The things currently in aztec
  • Guides
    • Includes getting-started
  • Examples
    • These are our tutorials
  • Reference
  • Resources
    • GitHub
      • aztec-packages
      • awesome-aztec
    • Other docs
      • Noir docs
      • Protocol spec
    • Support
      • Discord
      • Newsletter

Tags

  • Every page should have a tag with at least one concept
    • Accounts
    • Notes
    • PXE
    • TXE
    • Contracts (private/public state/functions)
    • Circuits (as much as a dev should know)
    • Portals
    • Fees
    • Privacy
    • CLI
    • LSP
    • Testing
  • Show tags on page that people can click on ✔️

Colours

Change colours to match Aztec colours

  • Background:
  • Headers:
  • Bullets:
  • Links:
  • Tips:
  • Warnings:

Search

  • filter search results by tag and category
  • use AI to figure out what they want
  • only explore the top level menu they are currently on
  • implement tracking
    • can implement specific queries
  • add synonyms
  • highlight parts of the tect that are relevent
  • autocomplete

@catmcgee
Copy link
Collaborator Author

catmcgee commented Aug 6, 2024

I marked sept 1st as deadline for design

@critesjosh
Copy link
Collaborator

critesjosh commented Aug 7, 2024

I see this is marked as done, can we close?

If you close the issue, it will automatically update to "Done".

@catmcgee catmcgee closed this as completed Aug 7, 2024
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