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.

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

docs: rewrite the explanation section #327

Merged
merged 22 commits into from
Aug 16, 2023

Conversation

SamirPS
Copy link
Contributor

@SamirPS SamirPS commented Jul 17, 2023

This PR add the explanation of Pebble and
rewrite chisel,rocks and overlay-step explanation.

  • Have you signed the CLA?

Fixes #337
Fixes #348

https://canonical-rockcraft--327.com.readthedocs.build/en/327/

docs/explanation/chisel.rst Outdated Show resolved Hide resolved
docs/_static/rockcraft_diagram.jpg Outdated Show resolved Hide resolved
docs/explanation/rocks.rst Outdated Show resolved Hide resolved
docs/explanation/rocks.rst Outdated Show resolved Hide resolved
docs/explanation/rocks.rst Outdated Show resolved Hide resolved
docs/explanation/rocks.rst Outdated Show resolved Hide resolved
@SamirPS SamirPS force-pushed the explanation-section branch 2 times, most recently from d9f1012 to 95be9ad Compare July 18, 2023 10:14
@SamirPS SamirPS marked this pull request as draft July 18, 2023 15:16
@SamirPS SamirPS force-pushed the explanation-section branch 3 times, most recently from d142dc1 to 010be0b Compare July 25, 2023 16:12
This PR add the explanation of Pebble and
rewrite chisel,rocks and overlay-step explanation.
Co-authored-by: Cristovao Cordeiro <[email protected]>
@cjdcordeiro cjdcordeiro added the documentation Improvements or additions to documentation label Jul 27, 2023
@cjdcordeiro cjdcordeiro self-requested a review July 31, 2023 13:42
@cjdcordeiro cjdcordeiro self-assigned this Jul 31, 2023
@cjdcordeiro cjdcordeiro removed their request for review July 31, 2023 13:42
@cjdcordeiro cjdcordeiro marked this pull request as ready for review July 31, 2023 13:42
@cjdcordeiro cjdcordeiro requested review from cjdcordeiro and removed request for cjdcordeiro July 31, 2023 13:42
docs/_static/css/custom.css Show resolved Hide resolved
docs/explanation/chisel.rst Show resolved Hide resolved
docs/explanation/chisel.rst Outdated Show resolved Hide resolved
docs/explanation/pebble.rst Show resolved Hide resolved
docs/explanation/pebble.rst Show resolved Hide resolved
docs/explanation/pebble.rst Outdated Show resolved Hide resolved
docs/explanation/pebble.rst Show resolved Hide resolved
docs/explanation/rocks.rst Show resolved Hide resolved
docs/explanation/rocks.rst Show resolved Hide resolved
@SamirPS
Copy link
Contributor Author

SamirPS commented Aug 2, 2023

LGTM ping @pedroleaoc for review @cjdcordeiro text

@cjdcordeiro cjdcordeiro requested review from tigarmo, cjdcordeiro and dboddie and removed request for cjdcordeiro and dboddie August 7, 2023 07:51
Copy link
Collaborator

@tigarmo tigarmo left a comment

Choose a reason for hiding this comment

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

thanks!

Makefile Outdated Show resolved Hide resolved
docs/_static/rock_diagram.png Outdated Show resolved Hide resolved
docs/explanation/pebble.rst Outdated Show resolved Hide resolved
docs/explanation/rocks.rst Outdated Show resolved Hide resolved
@cjdcordeiro
Copy link
Collaborator

thanks for the review @tigarmo

I've updated the PR. Please note that this PR also contains a fix for the currently broken docs header styling -> https://canonical-rockcraft.readthedocs-hosted.com/en/latest/

@cjdcordeiro cjdcordeiro requested review from tigarmo and lengau and removed request for dboddie August 14, 2023 12:02
@sergiusens sergiusens changed the title docs: Rewrite the explanation section docs: rewrite the explanation section Aug 14, 2023
Makefile Outdated Show resolved Hide resolved
Co-authored-by: Sergio Schvezov <[email protected]>
Copy link
Contributor

@lengau lengau left a comment

Choose a reason for hiding this comment

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

This looks great! (And please keep them coming — reviewing documentation PRs is honestly one of the best ways to keep keep me up to date on the state of Rockcraft, so I'm grateful for the opportunity.)

The comments I've added below are with my mental "grammar and style knobs" tuned to maximum sensitivity. None of them are strictly necessary, but I'd rather offer 10 suggestions where you prefer the original for 9 of them than miss an improvement you'd like too. So feel free to pick and choose only the suggestions you personally prefer ­— even if that turns out to be none of them.

docs/explanation/pebble.rst Outdated Show resolved Hide resolved
docs/explanation/pebble.rst Show resolved Hide resolved
docs/explanation/pebble.rst Outdated Show resolved Hide resolved
docs/explanation/pebble.rst Outdated Show resolved Hide resolved
docs/explanation/pebble.rst Outdated Show resolved Hide resolved
docs/explanation/pebble.rst Outdated Show resolved Hide resolved
docs/explanation/rocks.rst Outdated Show resolved Hide resolved
docs/explanation/rocks.rst Outdated Show resolved Hide resolved
docs/explanation/rocks.rst Outdated Show resolved Hide resolved
docs/explanation/rocks.rst Outdated Show resolved Hide resolved
cjdcordeiro
cjdcordeiro previously approved these changes Aug 16, 2023
@cjdcordeiro cjdcordeiro dismissed their stale review August 16, 2023 11:32

not reviewing my own commits

@cjdcordeiro cjdcordeiro merged commit 0e36ee7 into canonical:main Aug 16, 2023
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug: docs missing header styling doc: **bold** style not being applied
6 participants