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: Cynthion documentation branch #33

Merged
merged 36 commits into from
Jul 1, 2024
Merged

docs: Cynthion documentation branch #33

merged 36 commits into from
Jul 1, 2024

Conversation

antoinevg
Copy link
Member

This is the Cynthion documentation branch.

@antoinevg antoinevg mentioned this pull request Jan 18, 2024
Closed
@antoinevg antoinevg force-pushed the documentation branch 5 times, most recently from 15f12d0 to 7771ef9 Compare January 23, 2024 15:50
@antoinevg antoinevg force-pushed the documentation branch 4 times, most recently from 583b941 to 61188bc Compare April 24, 2024 14:56
@antoinevg antoinevg changed the title DRAFT: Cynthion documentation branch docs: Cynthion documentation branch Apr 26, 2024
@antoinevg antoinevg force-pushed the documentation branch 6 times, most recently from 2a5819b to 21fb47b Compare May 10, 2024 14:29
@antoinevg antoinevg force-pushed the documentation branch 2 times, most recently from 641ebef to 7a3bf04 Compare May 23, 2024 14:45
mossmann
mossmann requested changes Jun 27, 2024
View reviewed changes
Copy link
Member

@mossmann mossmann left a comment

Choose a reason for hiding this comment

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

Great job! I'm very excited to get this cleaned up and merged. I think it is close, but I would like to see several changes. Perhaps the most important change is that the two photographs could be much smaller. I would rather not have giant images taking up room in the repo forever. Also, can the photographs be JPEGs instead of PNGs?

docs/source/developer/bitstream_generation.rst Outdated Show resolved Hide resolved
docs/source/developer/cli.rst Show resolved Hide resolved
docs/source/developer/introduction.rst Outdated Show resolved Hide resolved
docs/source/getting_started.rst Show resolved Hide resolved
docs/source/developer/soc_firmware_compilation.rst Outdated Show resolved Hide resolved
docs/source/getting_started_facedancer.rst Show resolved Hide resolved
docs/source/getting_started_facedancer.rst Outdated Show resolved Hide resolved
docs/source/getting_started_facedancer.rst Outdated Show resolved Hide resolved
docs/source/getting_started_facedancer.rst Outdated Show resolved Hide resolved
docs/source/getting_started_usbproxy.rst Show resolved Hide resolved
@antoinevg antoinevg marked this pull request as ready for review June 28, 2024 10:12
@antoinevg antoinevg requested a review from mossmann June 28, 2024 10:55
@antoinevg antoinevg requested a review from martinling June 28, 2024 13:51
claui
claui reviewed Jul 1, 2024
View reviewed changes
Copy link

@claui claui left a comment

Choose a reason for hiding this comment

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

Thanks for a thorough and clear documentation. Great job!

Hope you don’t mind a couple of drive-by proofreading nitpicks.

cynthion/python/examples/facedancer-rubber-ducky.py Outdated Show resolved Hide resolved
cynthion/python/examples/facedancer-usbproxy.py Outdated Show resolved Hide resolved
docs/source/developer/bitstream_generation.rst Outdated Show resolved Hide resolved
docs/source/developer/bitstream_generation.rst Outdated Show resolved Hide resolved
docs/source/developer/bitstream_generation.rst Outdated Show resolved Hide resolved
docs/source/developer/soc_firmware_compilation.rst Outdated Show resolved Hide resolved
docs/source/developer/soc_firmware_compilation.rst Outdated Show resolved Hide resolved
docs/source/developer/introduction.rst Outdated Show resolved Hide resolved
docs/source/developer/introduction.rst Outdated Show resolved Hide resolved
docs/source/developer/introduction.rst Outdated Show resolved Hide resolved
@antoinevg antoinevg requested a review from claui July 1, 2024 14:09
claui
claui approved these changes Jul 1, 2024
View reviewed changes
Copy link

@claui claui left a comment

Choose a reason for hiding this comment

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

Looks great now!
(Assuming you’re aware of the remaining TODO markers throughout the doc.)

martinling
martinling approved these changes Jul 1, 2024
View reviewed changes
Copy link
Member

@martinling martinling left a comment

Choose a reason for hiding this comment

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

Looks good to me. Obviously there's still things to add but everything here looks fine and we should go ahead and get it in.

mossmann
mossmann approved these changes Jul 1, 2024
View reviewed changes
Copy link
Member

@mossmann mossmann left a comment

Choose a reason for hiding this comment

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

Fabulous! Thank you @antoinevg and reviewers!

@mossmann mossmann merged commit 32374a7 into main Jul 1, 2024
34 checks passed
@mossmann mossmann deleted the documentation branch July 1, 2024 15:19
@antoinevg antoinevg mentioned this pull request Jul 5, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@claui claui claui approved these changes

@mossmann mossmann mossmann approved these changes

@martinling martinling martinling approved these changes

Assignees

@antoinevg antoinevg

@straithe straithe

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@antoinevg @martinling @mossmann @claui @straithe