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

feat: create documentation guideline articles #11

Merged
merged 7 commits into from
Apr 9, 2024
Merged

feat: create documentation guideline articles #11

merged 7 commits into from
Apr 9, 2024

Conversation

itsacoyote
Copy link
Contributor

@itsacoyote itsacoyote commented Apr 4, 2024 •
edited
Loading

What 💻

  • Created a collection of articles on Documentation Contribution Guidelines
    • Contributing
    • Contribution Guidelines
    • Documentation Styleguide
  • Created a Resources section
    • Glossary

Why ✋

  • Create a set of standards to help with consistency across our documentation.

@itsacoyote itsacoyote requested a review from dutterbutter April 4, 2024 17:00
@itsacoyote itsacoyote force-pushed the itsacoyote-devrl-400-writing-guide branch 2 times, most recently from 7da24e1 to 067ea0a Compare April 4, 2024 19:58
@itsacoyote itsacoyote force-pushed the itsacoyote-devrl-400-writing-guide branch from 067ea0a to d8f8d3a Compare April 4, 2024 19:59
@github-actions GitHub Actions
Copy link

github-actions bot commented Apr 4, 2024 •
edited
Loading

Visit the preview URL for this PR (updated for commit 9655827):

https://zksync-docs-staging-5eb09--pr11-itsacoyote-devrl-400-dbv4lj35.web.app

(expires Tue, 16 Apr 2024 16:13:02 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: bfaafba5fa82d4f63473aaa76a21fabf1fbb3a11

@itsacoyote itsacoyote marked this pull request as ready for review April 4, 2024 20:31
@itsacoyote itsacoyote requested a review from a team as a code owner April 4, 2024 20:31
dutterbutter
dutterbutter requested changes Apr 4, 2024
View reviewed changes
Copy link
Contributor

@dutterbutter dutterbutter left a comment

Choose a reason for hiding this comment

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

This is incredibly helpful. Thank you 🙏

content/90.contributing-to-documentation/10.index.md Show resolved Hide resolved
content/90.contributing-to-documentation/10.index.md Show resolved Hide resolved
content/90.contributing-to-documentation/20.contribution-guidelines.md Outdated Show resolved Hide resolved
content/90.contributing-to-documentation/20.contribution-guidelines.md Outdated Show resolved Hide resolved
content/90.contributing-to-documentation/30.documentation-styleguide.md Outdated Show resolved Hide resolved
content/90.contributing-to-documentation/30.documentation-styleguide.md Show resolved Hide resolved
content/90.contributing-to-documentation/30.documentation-styleguide.md Show resolved Hide resolved
content/90.contributing-to-documentation/30.documentation-styleguide.md Show resolved Hide resolved
content/95.resources/20.glossary.md Outdated Show resolved Hide resolved
@itsacoyote itsacoyote merged commit ef82423 into staging Apr 9, 2024
7 checks passed
@itsacoyote itsacoyote deleted the itsacoyote-devrl-400-writing-guide branch April 9, 2024 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@uF4No uF4No uF4No left review comments

@dutterbutter dutterbutter dutterbutter approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@itsacoyote @uF4No @dutterbutter