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.

Sign up for GitHub

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

Jump to bottom

[Docs]: Update Notes section #1013

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

[Docs]: Update Notes section #1013

wants to merge 11 commits into from

Conversation

phklive
Copy link
Contributor

@phklive phklive commented Dec 11, 2024 •
edited
Loading

In this PR I propose to update the Notes section of the Miden documentation:

  • more explanative
  • more approachable for new developers
  • shortened
  • simplified
  • re-phrased
  • updated structure

@phklive phklive added the no changelog This PR does not require an entry in the `CHANGELOG.md` file label Dec 11, 2024
@phklive phklive self-assigned this Dec 11, 2024
@phklive phklive marked this pull request as ready for review December 11, 2024 13:32
@phklive phklive requested a review from Dominik1999 December 11, 2024 13:40
Dominik1999
Dominik1999 approved these changes Dec 12, 2024
View reviewed changes
Copy link
Collaborator

@Dominik1999 Dominik1999 left a comment

Choose a reason for hiding this comment

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

Looks very good, thanks. I left a couple of comments

docs/architecture/notes.md Show resolved Hide resolved
docs/architecture/notes.md Outdated Show resolved Hide resolved
docs/architecture/notes.md Outdated Show resolved Hide resolved
docs/architecture/notes.md Outdated Show resolved Hide resolved
docs/architecture/notes.md Outdated Show resolved Hide resolved
docs/architecture/notes.md Outdated Show resolved Hide resolved
docs/architecture/notes.md Outdated Show resolved Hide resolved
docs/architecture/notes.md Outdated Show resolved Hide resolved
docs/architecture/notes.md Outdated Show resolved Hide resolved
docs/architecture/notes.md Outdated Show resolved Hide resolved
@phklive phklive requested a review from Dominik1999 December 13, 2024 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Dominik1999 Dominik1999 Awaiting requested review from Dominik1999

Assignees

@phklive phklive

Labels
no changelog This PR does not require an entry in the `CHANGELOG.md` file
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@phklive @Dominik1999