Skip to content

Commit

Permalink
Update README.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
LandauRaz authored Feb 18, 2025
1 parent 54e3083 commit e5d9419
Showing 1 changed file with 12 additions and 68 deletions.
80 changes: 12 additions & 68 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,76 +1,21 @@
[id="readme"]

= 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.
Welcome to the https://docs.starknet.io[Starknet Docs^] repository, written in https://asciidoc.org/[AsciiDoc^] and built using https://antora.org/[Antora^].

== 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.

|===

|*Question* |*Resource*

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

|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].

| Is there a style guide and writing guide I should use?
| See the xref:contributing_to_docs/starknet_docs_style_guide.adoc[Starknet documentation supplementary style guide].

|How do I set up my workstation?
|See xref:contributing_to_docs/setting_up_environment.adoc[Setting up your environment].

|===

[#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?*

When you submit a PR, the Starknet Docs team reviews the PR and arranges further technical reviews as necessary. If the PR requires changes, the reviewers add comments to 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).


== Tips on authoring

* xref:contributing_to_docs/starknet_docs_style_guide.adoc[Starknet documentation supplementary style guide]: General style guidance and writing guidance.

For information on writing in AsciiDoc, see:

* link:https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc Language Documentation]
* link:http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/[AsciiDoc Syntax Quick Reference]

[NOTE]
====
There are multiple ways of coding ids, source code blocks, cross-references, and links. In general we use the most explicit coding conventions for coding in order to prioritize code readability. Most of these coding conventions are listed in link:https://redhat-documentation.github.io/asciidoc-markup-conventions/[AsciiDoc Mark-up Quick Reference for Red Hat Documentation]
====

== Before you begin
To build and preview content locally, first:

. Install `yarn` if it's not already installed.
. Install `npx` if it's not already installed.
. Clone this repo, either from a fork, or if you are an official collaborator, then directly from `starknet-io/starknet-docs`.
. Change to the `starknet-docs` directory.
. Run the `yarn` command to prepare the environment:
. Clone this repo, either from a fork or directly from `starknet-io/starknet-docs` (if you are an official collaborator).
. Nativgate into the `starknet-docs` directory and run the `yarn` command to prepare the environment:
+
----
yarn
cd starknet-docs && yarn
----

`yarn` should prepare your environment by installing the required modules based on `package-lock.json` and `package.json`. If it was successful, you should be able to build and preview content.

== Building and previewing content locally

After writing or editing content, to preview your changes:
Then:

. Build the content with Antora:
+
Expand All @@ -79,18 +24,16 @@ After writing or editing content, to preview your changes:
npx antora playbook.yml
----
+
This command generates the website in the directory `public_html`.
. Open the website by doing one of the following:
+
* Open the start page: `<repo_root>/public_html/index.html`.
* Run the xref:http_server[http server] packaged with Antora:
generating the website in the `public_html` directory.

. Run the http server packaged with Antora:
+
[source,bash]
----
npx http-server public_html -c-1
----
+
The server runs, and gives you one or more local URLs that you can use to view the website. For example:
giving you one or more local URLs that you can use to view the website, e.g.:
+
[source,bash,subs="+quotes,+macros"]
----
Expand All @@ -104,5 +47,6 @@ Available on:
\http://192.168.14.3:8080
\http://10.14.0.2:8080
Hit CTRL-C to stop the server
----

After writing or editing content, rebuild it to preview your changes (rerunning the server is not necessary).

0 comments on commit e5d9419

Please sign in to comment.