Skip to content

Conversation

@critesjosh
Copy link
Contributor

@critesjosh critesjosh commented Aug 21, 2025

⚠️ this PR builds off of the changes in #16442, so merge that one first

This PR makes several edits to the docs. The main impetus behind the changes being made is to make a more linear learning journey for developers as they move down the sidebar.

  • moves the guides section above the tutorials
  • flattens the pages inside the "Developer smart contracts" section
  • makes the "developing smart contracts" section a more linear flow for how a developer should be moving through this content
  • moves some of the technical explanations to the concepts section
  • adds a several pages to the Guides section including:
    • project sturcturing
    • data types
    • custom types
    • defining functions (initializer page moved into here)
  • removes some explainers and reference about storage from the references section into the guides section

closes: AztecProtocol/dev-rel#598

@critesjosh critesjosh marked this pull request as ready for review September 2, 2025 14:37
@critesjosh critesjosh requested review from a team and alejoamiras September 2, 2025 15:38
Copy link
Contributor

@signorecello signorecello left a comment

Choose a reason for hiding this comment

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

LGTM. I could look for small nits but I'd rather iterate fast than dragging this PR

⚠️ this PR builds off of the changes in #16442, so merge that one first

This PR makes several edits to the docs. The main impetus behind the changes being made is to make a more linear learning journey for developers as they move down the sidebar.

- moves the guides section above the tutorials
- flattens the pages inside the "Developer smart contracts" section
- makes the "developing smart contracts" section a more linear flow for how a developer should be moving through this content
- moves some of the technical explanations to the concepts section
- adds a several pages to the Guides section including:
  - project sturcturing
  - data types
  - custom types
  - defining functions (initializer page moved into here)
 - removes some explainers and reference about storage from the references section into the guides section

closes: AztecProtocol/dev-rel#598

Co-authored-by: Alex Gherghisan <alexghr@users.noreply.github.com>
Co-authored-by: Charlie Lye <5764343+charlielye@users.noreply.github.com>
Co-authored-by: Facundo <fcarreiro@users.noreply.github.com>
Co-authored-by: IlyasRidhuan <ilyasridhuan@gmail.com>
Co-authored-by: Jonathan Hao <jonathanpohsianghao@gmail.com>
Co-authored-by: Josh Crites <jc@joshcrites.com>
Co-authored-by: José Pedro Sousa <outgoing@zpedro.dev>
Co-authored-by: LHerskind <16536249+LHerskind@users.noreply.github.com>
Co-authored-by: Lasse Herskind <16536249+LHerskind@users.noreply.github.com>
Co-authored-by: Raju Krishnamoorthy <krishnamoorthy@gmail.com>
Co-authored-by: fcarreiro <facundo@aztecprotocol.com>
Co-authored-by: federicobarbacovi <171914500+federicobarbacovi@users.noreply.github.com>
Co-authored-by: jeanmon <jean@aztec-labs.com>
Co-authored-by: maramihali <mara@aztec-labs.com>
Co-authored-by: sergei iakovenko <105737703+iakovenkos@users.noreply.github.com>
Co-authored-by: sirasistant <sirasistant@gmail.com>
Co-authored-by: thunkar <gregojquiros@gmail.com>
@AztecBot AztecBot force-pushed the jc/docs/how-to-update branch from de095be to ab8eff0 Compare September 3, 2025 15:22
@AztecBot AztecBot enabled auto-merge September 3, 2025 15:23
@AztecBot AztecBot added this pull request to the merge queue Sep 3, 2025
Merged via the queue into next with commit 8f8be9a Sep 3, 2025
15 checks passed
@AztecBot AztecBot deleted the jc/docs/how-to-update branch September 3, 2025 16:10
ludamad pushed a commit that referenced this pull request Dec 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Learning journey: update Writing Contracts section

4 participants