Skip to content

[doc] Release procedure documented#623

Merged
marnovandermaas merged 4 commits into
lowRISC:mainfrom
marnovandermaas:doc_release_proc
Jun 24, 2026
Merged

[doc] Release procedure documented#623
marnovandermaas merged 4 commits into
lowRISC:mainfrom
marnovandermaas:doc_release_proc

Conversation

@marnovandermaas

@marnovandermaas marnovandermaas commented Jun 21, 2026

Copy link
Copy Markdown
Collaborator

This also removes the quick start guide from dev_guide.md to avoid too much repetition.

Closes: #34

@marnovandermaas

marnovandermaas commented Jun 21, 2026

Copy link
Copy Markdown
Collaborator Author

Testing and quick start instructions for Linux should be added.

@marnovandermaas marnovandermaas force-pushed the doc_release_proc branch 2 times, most recently from 0a696fa to 6e6e4eb Compare June 21, 2026 23:54

@raylau1 raylau1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A few minor comments from my end.

Comment thread doc/ref/release.md
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/release.md Outdated
@marnovandermaas marnovandermaas force-pushed the doc_release_proc branch 4 times, most recently from a56aae8 to 3002fd2 Compare June 23, 2026 08:27

@raylau1 raylau1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A few wording nits, otherwise LGTM.

Comment thread doc/ref/release.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
@marnovandermaas marnovandermaas force-pushed the doc_release_proc branch 3 times, most recently from 6516ca9 to 20f0379 Compare June 23, 2026 10:40
Comment thread README.md Outdated
@marnovandermaas marnovandermaas force-pushed the doc_release_proc branch 3 times, most recently from 40db9b1 to 826f980 Compare June 23, 2026 16:04
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/release.md
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/release.md
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/release.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/dev_guide.md Outdated
Comment thread util/fpga_runner.py
Comment thread doc/ref/dev_guide.md
Comment thread doc/ref/release.md Outdated
Comment thread doc/ref/release.md
@marnovandermaas marnovandermaas force-pushed the doc_release_proc branch 4 times, most recently from 53d665e to 243e2b4 Compare June 24, 2026 09:30

@raylau1 raylau1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for all the good work! LGTM.

@marnovandermaas marnovandermaas force-pushed the doc_release_proc branch 3 times, most recently from d5f9959 to 93e25c8 Compare June 24, 2026 11:05
This also removes the quick start guide from dev_guide.md to avoid too
much repetition.

Signed-off-by: Marno van der Maas <mvdmaas+git@lowrisc.org>
Also avoid using hard-coded TTY number.

Signed-off-by: Marno van der Maas <mvdmaas+git@lowrisc.org>
Signed-off-by: Marno van der Maas <mvdmaas+git@lowrisc.org>
Test all the commands

Signed-off-by: Marno van der Maas <mvdmaas+git@lowrisc.org>
@marnovandermaas marnovandermaas added this pull request to the merge queue Jun 24, 2026
Merged via the queue into lowRISC:main with commit 0f4ec29 Jun 24, 2026
9 of 10 checks passed
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.

[DOC] The release procedure

4 participants