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

Docs structure overhaul updated #508

Merged
merged 5 commits into from
Sep 26, 2024

Conversation

a-zorina
Copy link
Contributor

Major overhaul of documentation structure and navigation.
The guide section is split into 4 separate sections, each with its own navigation sidebar:

Get Started - just the starter guides to onboard newbies
Build on Iroha - everything related to developing on Iroha (SDK guides, configuration and management, security, etc)
Iroha Explained - core concepts and architecture
Help - where to get help and troubleshooting advice

The reference section is unchanged.

Copy link

vercel bot commented Sep 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
iroha-2-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 26, 2024 3:04pm

Copy link

@Mingela Mingela left a comment

Choose a reason for hiding this comment

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

please just consider most of the comments for the future though you may already have realized a lot of scope as of content reworking

src/blockchain/assets.md Outdated Show resolved Hide resolved
src/blockchain/assets.md Outdated Show resolved Hide resolved
src/blockchain/assets.md Outdated Show resolved Hide resolved
src/blockchain/assets.md Outdated Show resolved Hide resolved
src/blockchain/assets.md Outdated Show resolved Hide resolved
src/blockchain/consensus.md Outdated Show resolved Hide resolved
src/blockchain/how-iroha-works.md Outdated Show resolved Hide resolved
src/blockchain/instructions.md Outdated Show resolved Hide resolved
src/blockchain/permissions.md Outdated Show resolved Hide resolved
src/blockchain/triggers.md Outdated Show resolved Hide resolved
@0x009922
Copy link
Contributor

From my perspective, I still prefer to have the two major sections:

  1. Guide - including "Getting Started" and subsections of "Build on Iroha"
  2. Reference - including "Iroha Explained" sections

As an example, here I think it works very well: https://vitepress.dev/

@a-zorina
Copy link
Contributor Author

From my perspective, I still prefer to have the two major sections:

1. **Guide** - including "Getting Started" and subsections of "Build on Iroha"

2. **Reference** - including "Iroha Explained" sections

As an example, here I think it works very well: https://vitepress.dev/

I have to argue against that. Iroha is a much more complicated entity than Vitepress. No blockchain project ever fits its docs in just two sections.
The Iroha Explained section in particular contains a type of information that is more theoretical in nature and listed under Guide it would both get on the way of readers who just want to learn by doing, and be hard to find for readers who want to learn the theory.
And avoiding overly long section sidebars that become hard to navigate is an added bonus here.

@a-zorina a-zorina marked this pull request as ready for review September 26, 2024 13:42
Signed-off-by: a-zorina <[email protected]>
@a-zorina a-zorina merged commit a3b05f2 into hyperledger-iroha:main Sep 26, 2024
6 checks passed
@a-zorina a-zorina deleted the new-structure branch September 26, 2024 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants