chore: docs restructure #2322

catmcgee · 2023-09-15T13:35:41Z

Removed some things from the sidebar that were empty/WIP
Filled out 'how to participate' and 'visibility' sections
Changed around structure to make it easier to follow
use #include_code macro to pull in code from tests for getting started page
closes Review the monorepo README #1905

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
Every change is related to the PR description.
I have linked this pull request to relevant issues (if any exist).

critesjosh · 2023-09-15T18:14:25Z

I will start reviewing this, thanks Cat!

cc @iAmMichaelConnor so you can flag anything that might be concerning

docs/docs/dev_docs/getting_started/quickstart.md

docs/docs/dev_docs/contracts/syntax/types.md

docs/docs/dev_docs/getting_started/sandbox.md

…rial

…ztec-packages into docs-restructure

docs/docs/dev_docs/getting_started/quickstart.md

iAmMichaelConnor · 2023-09-18T18:02:09Z

docs/docs/dev_docs/getting_started/quickstart.md

+```
+
+NOTE: If `SANDBOX_VERSION` is not defined, the script will pull the latest release of the sandbox.
+


There's another 'getting started' guide somewhere that mentions port conflicts. We should mention that here too. If they get errors about port conflicts, when running this curl command, they should check whether those ports are already in use (insert the commands which would enable someone to check conflicting ports for 8080 and 8545).
To specify different ports, they'd need to edit the docker-compose file which got saved in .aztec/docker-compose.yml: nano .aztec/docker-compose.yml then change PORTS: 8080:8080 to PORTS: <other port>:8080 (and same for 8545 if there's a conflict at that port too). (I might have got the docker compose syntax wrong - I'm basing this off memory).

(As an alternative to modifying the docker-compose.yml, a user might be able to specify an env file (from memory), with overwrites to the ports)

Then, when doing CLI commands, they'd need to specify --rpc-url=<other port> with each cli command.

Also, if they re-run the curl command, it will overwrite their custom changes to the port number in the docker-compose.yml file. (So the env file approach might be better)

Can we open a new issue to change the port from 8080 to 4273 (because it looks like AZTE(c)) and because 8080 is used by everything (especially the mainframe!)

I am testing out editing the docker-comose.yml file. It looks like its <other port>:8080, but when it starts up it still prints sandbox Aztec Sandbox JSON-RPC Server listening on port 8080 in the terminal even when it's been changed.

I'll update the quickstart page with this note.

created an issue here: #2381

I likely wont have time to add this to the docs in the next couple days, but can do later.

but when it starts up it still prints sandbox Aztec Sandbox JSON-RPC Server listening on port 8080

Ah, yeah that'll be because from the sandbox's perspective, it's still communicating via port 8080 (regardless of which port you forward from your local machine)

add discord link, remove unused files/sections, update links

critesjosh

thanks for starting this @catmcgee! I am going to merge these changes and we can make additional edits if necessary.

signorecello · 2023-09-19T09:18:45Z

@critesjosh I'm late to the party but I wonder if this is being deployed to netlify? Would be great to have a preview for docs changes

🤖 I have created a release *beep* *boop* --- <details><summary>aztec-packages: 0.7.8</summary> ## [0.7.8](aztec-packages-v0.7.7...aztec-packages-v0.7.8) (2023-09-19) ### Features * `NodeInfo` cleanup ([#2370](#2370)) ([89fe978](89fe978)) * Allow custom ports in sandbox ([#2393](#2393)) ([41ef378](41ef378)) * Allow tracing build system with [debug ci] ([#2389](#2389)) ([ce311a9](ce311a9)) * **docs:** Show current noir version for aztec in docs ([#2379](#2379)) ([5c7b2ab](5c7b2ab)) ### Bug Fixes * Build script exiting on failed grep ([#2384](#2384)) ([e70a781](e70a781)) * Bump e2e_sandbox_example.test.ts timeout ([#2391](#2391)) ([9a1bb62](9a1bb62)) * Compile script for the unboxed project ([#2380](#2380)) ([2801da2](2801da2)) * Force_deploy_build error ([#2375](#2375)) ([4d1cbf9](4d1cbf9)) * Update aztec sandbox getting started markdown ([#2374](#2374)) ([a3c6bcf](a3c6bcf)) ### Miscellaneous * Adds on-brand design to private token project ([#2355](#2355)) ([072e313](072e313)) * Docs restructure ([#2322](#2322)) ([1368b55](1368b55)) ### Documentation * Updated noirup command ([#2339](#2339)) ([5308c21](5308c21)) </details> <details><summary>barretenberg.js: 0.7.8</summary> ## [0.7.8](barretenberg.js-v0.7.7...barretenberg.js-v0.7.8) (2023-09-19) ### Miscellaneous * **barretenberg.js:** Synchronize aztec-packages versions </details> <details><summary>barretenberg: 0.7.8</summary> ## [0.7.8](barretenberg-v0.7.7...barretenberg-v0.7.8) (2023-09-19) ### Features * Allow tracing build system with [debug ci] ([#2389](#2389)) ([ce311a9](ce311a9)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

critesjosh · 2023-09-19T11:10:27Z

Yes it is. The problem is that previews will be created for every PR, which is irrelevant for most PRs and its noisy. That's why I turned it off. You can preview locally.

catmcgee added 8 commits September 15, 2023 11:29

syntax sidebar

124d627

syntax and roadmap structure

40572ad

sidebar

269ae1c

commented out empty sidebar elements

2b8ed8c

redirects

9faa1d5

filled in some pages

64a8129

typo

d79a0c6

fix yarn.lock

a6bf573

catmcgee requested review from critesjosh and signorecello September 15, 2023 13:35

catmcgee changed the title ~~WIP: Docs restructure~~ WIP: chore: docs restructure Sep 15, 2023

catmcgee and others added 3 commits September 15, 2023 15:46

merge conflicts

b9e8eae

Merge branch 'master' into docs-restructure

6865c56

Merge branch 'master' into docs-restructure

6cd3450

iAmMichaelConnor reviewed Sep 15, 2023

View reviewed changes

docs/docs/dev_docs/getting_started/quickstart.md Outdated Show resolved Hide resolved

docs/docs/dev_docs/contracts/syntax/types.md Outdated Show resolved Hide resolved

iAmMichaelConnor reviewed Sep 15, 2023

View reviewed changes

docs/docs/dev_docs/getting_started/sandbox.md Outdated Show resolved Hide resolved

critesjosh added 4 commits September 15, 2023 14:57

some cleanup, added note on default accounts, add token contract tuto…

0fd93d8

…rial

clean urls, edits

0168a97

add titles, notes

e3286a8

add/remove links, update headings

49d1dee

This was referenced Sep 18, 2023

fix: export $CONTRACT var in end to end test #2344

Closed

Review the monorepo README #1905

Closed

critesjosh and others added 7 commits September 18, 2023 10:52

add popular packages to main README

244b5e4

reference test code, update test

4db7fa4

add title

dc789d2

Merge branch 'master' into docs-restructure

6a215fd

update quickstart to use standard token contract

b7e3243

updates

57f2afe

rename sandbox.md to aztecjs.md

ef50a70

critesjosh and others added 9 commits September 18, 2023 12:17

remove types.md

b2817a7

add background

6ae0b99

move template to root so it doesn't appear in the page build

44e2b4f

Merge branch 'master' into docs-restructure

a316292

Merge branch 'docs-restructure' of https://github.com/AztecProtocol/a…

6bed496

…ztec-packages into docs-restructure

Merge branch 'master' into docs-restructure

d7599a0

move internal docs

5af1104

add redirects

d498a62

edits

ab3639f

iAmMichaelConnor reviewed Sep 18, 2023

View reviewed changes

docs/docs/dev_docs/getting_started/quickstart.md Show resolved Hide resolved

iAmMichaelConnor reviewed Sep 18, 2023

View reviewed changes

critesjosh added 5 commits September 18, 2023 14:44

rename back to sandbox

8d52556

fix headings

134df4c

use installnargo component

73609d8

Merge branch 'master' into docs-restructure

26342bf

minor updates

3949057

critesjosh changed the title ~~WIP: chore: docs restructure~~ chore: docs restructure Sep 18, 2023

critesjosh and others added 3 commits September 18, 2023 19:58

Merge branch 'master' into docs-restructure

eddcde1

fix links

4251b42

various updates

ee8cf3a

add discord link, remove unused files/sections, update links

critesjosh approved these changes Sep 19, 2023

View reviewed changes

critesjosh merged commit 1368b55 into master Sep 19, 2023

critesjosh deleted the docs-restructure branch September 19, 2023 01:15

AztecBot mentioned this pull request Sep 19, 2023

chore(master): Release 0.7.8 #2376

Merged

This was referenced Sep 19, 2023

Multi-day Sandbox deep dive Getting Started guide AztecProtocol/dev-rel#39

Open

Restructure docs and remove empty pages AztecProtocol/dev-rel#56

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: docs restructure #2322

chore: docs restructure #2322

catmcgee commented Sep 15, 2023 •

edited by critesjosh

Loading

critesjosh commented Sep 15, 2023

iAmMichaelConnor Sep 18, 2023 •

edited

Loading

iAmMichaelConnor Sep 18, 2023 •

edited

Loading

iAmMichaelConnor Sep 18, 2023

critesjosh Sep 18, 2023

critesjosh Sep 18, 2023

iAmMichaelConnor Sep 18, 2023 •

edited

Loading

critesjosh left a comment

signorecello commented Sep 19, 2023 •

edited

Loading

critesjosh commented Sep 19, 2023 •

edited

Loading

		```

		NOTE: If `SANDBOX_VERSION` is not defined, the script will pull the latest release of the sandbox.

chore: docs restructure #2322

chore: docs restructure #2322

Conversation

catmcgee commented Sep 15, 2023 • edited by critesjosh Loading

Checklist:

critesjosh commented Sep 15, 2023

iAmMichaelConnor Sep 18, 2023 • edited Loading

Choose a reason for hiding this comment

iAmMichaelConnor Sep 18, 2023 • edited Loading

Choose a reason for hiding this comment

iAmMichaelConnor Sep 18, 2023

Choose a reason for hiding this comment

critesjosh Sep 18, 2023

Choose a reason for hiding this comment

critesjosh Sep 18, 2023

Choose a reason for hiding this comment

iAmMichaelConnor Sep 18, 2023 • edited Loading

Choose a reason for hiding this comment

critesjosh left a comment

Choose a reason for hiding this comment

signorecello commented Sep 19, 2023 • edited Loading

critesjosh commented Sep 19, 2023 • edited Loading

catmcgee commented Sep 15, 2023 •

edited by critesjosh

Loading

iAmMichaelConnor Sep 18, 2023 •

edited

Loading

iAmMichaelConnor Sep 18, 2023 •

edited

Loading

iAmMichaelConnor Sep 18, 2023 •

edited

Loading

signorecello commented Sep 19, 2023 •

edited

Loading

critesjosh commented Sep 19, 2023 •

edited

Loading