docs: add Intro architecture

starknet-io / starknet-docs

The repo for Starknet's developer documentation. Includes contribution guidelines and the Starknet documentation supplementary style guide

https://docs.starknet.io/

112 stars 159 forks source link

docs: add Intro architecture #1167

Closed omarespejel closed 3 months ago

omarespejel commented 4 months ago

Description of the Changes

Enhancement: This PR introduces a comprehensive addition to the documentation focused on Starknet's architecture. It provides a detailed overview of the pivotal components within the Starknet ecosystem, including Sequencers, Provers, and nodes.

PR Preview URL

https://starknet-io.github.io/starknet-docs/pr-1167/documentation/architecture_and_concepts/Network_Architecture/introduction/

Check List

[X] Changes have been done against main branch, and PR does not conflict
[X] PR title follows the convention: <docs/feat/fix/chore>(optional scope): <description>, e.g: fix: minor typos in code

This change is

github-actions[bot] commented 4 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1167/documentation/ .

stoobie commented 4 months ago

Thoughts:

Which is better: More content on a single page, or smaller chunks of content on multiple pages. I've seen pros and cons for both. How did you decide to make this one large page as opposed to individual pages for Provers, Sequencers, Nodes etc.?
Given the introductory nature of the Book, and its different style, my gut suggests that we keep it as its own unit within the site. I'm working on a TOC and will share it.

github-actions[bot] commented 4 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1167/documentation/ .

omarespejel commented 4 months ago

What you mention makes sense. I will propose a couple more PRs to better detail the components mentioned: Sequencer, Prover, Nodes.

omarespejel commented 4 months ago

@stoobie, if you consider it good. I think we can merge.

github-actions[bot] commented 3 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1167/documentation/ .

github-actions[bot] commented 3 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1167/documentation/ .

github-actions[bot] commented 3 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1167/documentation/ .

github-actions[bot] commented 3 months ago

Your preview build is ready! ✨ Check the following link in 1-2 minutes: https://starknet-io.github.io/starknet-docs/pr-1167/documentation/ .