Skip to content

docs: Update docs readme#14538

Closed
jzaki wants to merge 7 commits intomasterfrom
jz/update-docs-readme
Closed

docs: Update docs readme#14538
jzaki wants to merge 7 commits intomasterfrom
jz/update-docs-readme

Conversation

@jzaki
Copy link
Contributor

@jzaki jzaki commented May 26, 2025

No description provided.

@jzaki jzaki requested a review from critesjosh May 26, 2025 18:19
@jzaki jzaki changed the title Update docs readme docs: Update docs readme May 26, 2025
@jzaki jzaki requested a review from saleel May 26, 2025 18:42
@github-actions
Copy link
Contributor

github-actions bot commented May 26, 2025

Docs Preview

You can check your preview here.

@AztecProtocol AztecProtocol deleted a comment from Nilzkool May 27, 2025
@jzaki jzaki force-pushed the jz/update-docs-readme branch 2 times, most recently from 6f1310b to 749e2d9 Compare May 27, 2025 15:41
docs/README.md Outdated

Adding docs:
- All docs changes, especially changes to `versioned_docs`, should only go to the `master` branch
- Exceptionally when documenting new protocol changes, these should go to the `next` branch, within `docs/docs`
Copy link
Contributor

Choose a reason for hiding this comment

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

I think all docs changes should go into master. We don't have to publish what's in docs/docs (like we do now), which will contain future changes. This should prevent merge conflicts, otherwise I don't see how to prevent conflicts when merging master into next.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated.

@jzaki jzaki force-pushed the jz/update-docs-readme branch from 749e2d9 to 5741acd Compare May 28, 2025 12:22
@jzaki jzaki requested a review from critesjosh May 28, 2025 12:23
@ludamad ludamad deleted the branch master February 5, 2026 17:50
@ludamad ludamad closed this Feb 5, 2026
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.

3 participants