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

feat: Add style guide and more details for contributing. #519

Merged
merged 25 commits into from
Jul 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
9c5038b
Add setting_up_environment.adoc, corresponding edits to README.adoc
stoobie Jun 6, 2023
dfeb996
Add doc_guidelines.adoc from OpenShift docs. Editing content.
stoobie Jun 6, 2023
6921cfc
Merge branch 'dev' into add_style_guide
stoobie Jun 6, 2023
dcadbdc
Add contributing.adoc.
stoobie Jun 6, 2023
e3511b2
Merge branch 'add_style_guide' of github.com:starknet-community-libs/…
stoobie Jun 6, 2023
c117e66
Edit contributing.adoc.
stoobie Jun 6, 2023
1620fae
Fixed partial$ syntax.
stoobie Jun 7, 2023
764ca56
More edits.
stoobie Jul 3, 2023
b4b0832
More edits.
stoobie Jul 3, 2023
3e507b3
More edits.
stoobie Jul 4, 2023
f0b8a7b
Merge branch 'dev' into add_style_guide
stoobie Jul 10, 2023
6c80aa5
Testing collapsible sections.
stoobie Jul 10, 2023
c3e02cb
Merge branch 'dev' into add_style_guide
stoobie Jul 10, 2023
1927840
Images, including source files.
stoobie Jul 10, 2023
a941ae6
Merge branch 'dev' into add_style_guide
stoobie Jul 10, 2023
2591434
Added clippy image. More edits.
stoobie Jul 10, 2023
e3e047d
Guidelines for prompts in code blocks.
stoobie Jul 10, 2023
f3e8f6e
More guideline edits.
stoobie Jul 10, 2023
d606860
More guideline edits.
stoobie Jul 10, 2023
ad7237b
More guideline edits.
stoobie Jul 10, 2023
3491c08
Moved style guidelines from doc_guidelines.adoc to starknet_docs_styl…
stoobie Jul 11, 2023
894d1fa
Added guidance on avoiding single headings in a given level
stoobie Jul 11, 2023
24632d6
Moving heading guidance to style guide.
stoobie Jul 11, 2023
245f653
Peer review comments and tightening up content. Removed `contributing…
stoobie Jul 12, 2023
ccaf437
Merge branch 'dev' into add_style_guide
stoobie Jul 12, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 24 additions & 18 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,34 +1,40 @@
[id="readme"]
= Read Me
= Starknet documentation repository
:toc:
:toclevels: 1

The Starknet docs website, https://docs.starknet.io, is written in https://asciidoc.org/[AsciiDoc] and is built using link:https://antora.org/[Antora], a static website generator for AsciiDoc.

The Starknet docs website, https://docs.starknet.io, is built using link:https://antora.org/[Antora], a static website generator for AsciiDoc.
== Contributing to Starknet documentation
If you are interested in contributing to Starknet technical documentation, the following table provides quick links to help you get started.

== Previewing the website on your local machine
|===

You don't need to install Antora to preview the website. This repo includes an embedded Antora installation, which is referred to in the Antora documentation as a _local installation_.
|Question |Resource

=== Prerequisites
|I'm interested, how do I contribute?
|For information on how you can contribute, see xref:#different_ways_to_contribute[Different ways to contribute].

You must have an active Node.js LTS release on your machine. See the _Antora documentation_ for your OS:
|Are there any basic guidelines to help me?
| For basic guidelines to help us keep our content consistent, see link:/contributing_to_docs/doc_guidelines.adoc[Documentation guidelines].

* https://docs.antora.org/antora/latest/install/linux-requirements/#node[Linux]
* https://docs.antora.org/antora/latest/install/windows-requirements/#node[Windows]
* https://docs.antora.org/antora/latest/install/macos-requirements/#node[macOS]
|How do I set up my workstation?
|See xref:contributing_to_docs/setting_up_environment.adoc[Setting up your environment].

[id="http_server"]
[TIP]
====
Install the optional link:https://docs.antora.org/antora/latest/preview-site/#run-a-local-server-optional[http server Antora provides] so you can view the output in a local web server
====
|===

[#different_ways_to_contribute]
== Different ways to contribute

There are a few different ways you can contribute to Starknet documentation:

* Create a link:https://github.com/starknet-io/starknet-docs/issues[GitHub issue].
* Submit a pull request (PR). You can create a local clone of your own fork of the link:https://github.com/starknet-io/starknet-docs[starknet-docs repository], make your changes, and submit a PR. This option is best if you have substantial changes, or to help the changes you want to be added more quickly.

*What happens when you submit a PR?*

== Git-related info
When you submit a PR, the https://github.com/orgs/starknet-io/teams/starknet-docs[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).

* Clone this repo to your local machine. Using a fork is optional.
* When naming a branch, if you do not use a fork, use the following format: `<name>/<short_description>`
* When creating a new PR, tag one or more of the following as reviewers: `stoobie`, `JameStark`

== Tips on authoring

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ If `block_number` is less than the first block number of v0.12.0, the function r
[id="get_execution_info"]
== `get_execution_info`

[%collapsible]
====

[discrete]
==== Syntax

Expand Down Expand Up @@ -66,6 +69,7 @@ None.
==== Common library

link:https://github.com/starkware-libs/cairo/blob/cca08c898f0eb3e58797674f20994df0ba641983/corelib/src/starknet/syscalls.cairo#L35[`syscalls.cairo`^]
====

[id="call_contract"]
== `call_contract`
Expand Down
Loading