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: add doc style tips to HACKING.md #1528

Merged
merged 2 commits into from
Jan 16, 2025
Merged

Conversation

dwilding
Copy link
Contributor

This PR adds a few style tips to the Documentation section of HACKING.md (the same ones we added to Pebble in canonical/pebble#556).

Copy link
Contributor

@james-garner-canonical james-garner-canonical 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. Would 'How to write great documentation' be better?

@dwilding
Copy link
Contributor Author

Nice suggestion @james-garner-canonical, thanks!

Copy link
Contributor

@dimaqq dimaqq left a comment

Choose a reason for hiding this comment

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

I like how the shape of the text serves as an example at the same time.

@dwilding dwilding merged commit e4e9307 into canonical:main Jan 16, 2025
31 of 32 checks passed
@dwilding dwilding deleted the doc-tips branch January 16, 2025 04:07
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