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

Add sample git workflow for dedicated docs repo #64

Merged
merged 1 commit into from
Jul 26, 2023

Conversation

pmatulis
Copy link

Include a sample Git workflow for importing the pack into a dedicated documentation repository.

Make all the lines in section "Standalone documentation repository" a maximum of 79 characters, as is good and proper ™️

Copy link
Contributor

@ru-fu ru-fu left a comment

Choose a reason for hiding this comment

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

Tbh, not a fan at all of breaking at 79 characters in documentation, since it makes both reviewing and writing so much harder.
Changes in docs are usually on a sentence level, so I consistently use the convention of one sentence per line (which shows as a paragraph in the output) - that way, I don't need to worry about reformatting the source after doing changes, and in the GitHub diff, you can see the actual changes and GitHub doesn't highlight random formatting.

But that's only my convention, so won't enforce it anywhere (except for the repos where it's up to me to decide ;) ).

@pmatulis pmatulis merged commit dcc5977 into canonical:main Jul 26, 2023
3 checks passed
@pmatulis pmatulis deleted the steps-for-importing-starter-pack branch July 26, 2023 21:57
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.

2 participants