feat: Add style guide and more details for contributing. #519
Conversation
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
stoobie
changed the title
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
…starknet-docs into add_style_guide
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
JameStark
force-pushed
the
dev
branch
2 times, most recently
from
c8da654 to
0ba9303
Compare
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
1 similar comment
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
There was a problem hiding this comment.
Reviewable status: 0 of 7 files reviewed, 1 unresolved discussion (waiting on @stoobie)
contributing_to_docs/doc_guidelines.adoc line 29 at r1 (raw file):
. xref:starknet_docs_style_guide.adoc[_Starknet documentation style guide_] Reference this guide first. It provides guidance that is specific to Starknet documentation. . link:https://redhat-documentation.github.io/supplementary-style-guide[_Red Hat supplementary style guide for product documentation_]. This guide overrides certain guidance from the _Google developer documentation style guide_. . link:https://developers.google.com/style[_Google developer documentation style guide_]
This order differs from https://github.com/starknet-io/starknet-docs/blob/add_style_guide/contributing_to_docs/starknet_docs_style_guide.adoc which states that 'the primary source of style guidance for Starknet documentation.'
Code quote:
. link:https://redhat-documentation.github.io/supplementary-style-guide[_Red Hat supplementary style guide for product documentation_]. This guide overrides certain guidance from the _Google developer documentation style guide_.
. link:https://developers.google.com/style[_Google developer documentation style guide_]
There was a problem hiding this comment.
Reviewable status: 0 of 7 files reviewed, 4 unresolved discussions (waiting on @stoobie)
README.adoc line 39 at r1 (raw file):
*What happens when you submit a PR?* When you submit a PR, the https://github.com/orgs/openshift/teams/team-documentation[Starknet Docs team] reviews the PR and arranges further technical reviews as necessary. If the PR requires changes, the reviewers add comments in the PR. We might request that you make the changes, or let you know that we incorporated your content in a different PR. Occasionally, we might add commits to the original PR directly. When the PR has been reviewed and all updates are complete, the documentation team merges the PR and applies it to the valid version(s).
Should this link to Starknet?
contributing_to_docs/contributing.adoc line 20 at r1 (raw file):
*What happens when you submit a PR?* When you submit a PR, the https://github.com/orgs/openshift/teams/team-documentation[Starknet Docs team] reviews the PR and arranges further technical reviews as necessary. If the PR requires changes, the reviewers add comments in the PR. We might request that you make the changes, or let you know that we incorporated your content in a different PR. Occasionally, we might add commits to the original PR directly. When the PR has been reviewed and all updates are complete, the documentation team merges the PR and applies it to the valid version(s).
Should this link to Starknet?
contributing_to_docs/doc_guidelines.adoc line 704 at r1 (raw file):
+ .... Create a secret that contains the certificate and key in the `openshift-config` namespace:
Starknet?
There was a problem hiding this comment.
Reviewable status: 0 of 7 files reviewed, 4 unresolved discussions (waiting on @JameStark)
README.adoc line 39 at r1 (raw file):
Previously, JameStark wrote…
Should this link to Starknet?
Done.
contributing_to_docs/doc_guidelines.adoc line 29 at r1 (raw file):
Previously, JameStark wrote…
This order differs from https://github.com/starknet-io/starknet-docs/blob/add_style_guide/contributing_to_docs/starknet_docs_style_guide.adoc which states that 'the primary source of style guidance for Starknet documentation.'
Well, this section talks about in what order ot use the guides. The section your quoting just names the guides. On that same page that you're quoting from, the next section provides the same order.
contributing_to_docs/doc_guidelines.adoc line 704 at r1 (raw file):
Previously, JameStark wrote…
Starknet?
Removed.
contributing_to_docs/contributing.adoc line 20 at r1 (raw file):
Previously, JameStark wrote…
Should this link to Starknet?
I deleted this file and moved any remaining content to doc_guidelines.adoc.
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
There was a problem hiding this comment.
Reviewable status: 0 of 7 files reviewed, all discussions resolved
|
Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-519/documentation/ . |
stoobie
changed the title
Description of the Changes
This PR adds a style guide and more details to the contribution guide. Content is based on the OpenShift docs repo.
This content is only viewable in this repo, it is not published on docs.starknet.io or anywhere else.
PR Preview URL
There is no Antora preview for this content. Ignore the preview that is generated for this PR.
Check List
<docs/feat/fix/chore>(optional scope): <description>, e.g:fix: minor typos in codeThis change is