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] Simplify docs to clarify key concepts #655

Open
joohhnnn opened this issue Apr 27, 2024 · 2 comments
Open

[DOCS] Simplify docs to clarify key concepts #655

joohhnnn opened this issue Apr 27, 2024 · 2 comments
Labels
community-request docs updates requested by community or OP collective documentation Improvements or additions to documentation

Comments

@joohhnnn
Copy link

Brief Description of the Docs Request

The request is to simplify the complexity of documentation on the website, with an emphasis on highlighting broad concepts through easily understandable visual and textual examples. The goal is to make the docs more accessible, especially for those without a development background.

Description of the Documentation You'd Like

Just like a normal learning path, you start with the big concepts, like from the official documentation. Then, I might go to places like SPECS to understand deeper mechanisms. Official docs could link to these places, but it’s probably best to avoid getting too bogged down in the nitty-gritty details.

Additional Context

Many users, particularly those without a technical background, find current documentation overwhelming due to its complexity and technical depth. By reorganizing the documentation to prioritize clarity and accessibility, and by providing clear links to more detailed content, we can improve the user experience. This approach not only aids in quicker comprehension but also encourages further exploration into more detailed aspects as needed, making the docs more effective and user-friendly.

@joohhnnn joohhnnn added community-request docs updates requested by community or OP collective documentation Improvements or additions to documentation labels Apr 27, 2024
@sbvegan
Copy link
Collaborator

sbvegan commented Apr 27, 2024

Thank you @joohhnnn for the feedback and I agree this would be a nice improvement to the fault proof overview page :)

@sbvegan
Copy link
Collaborator

sbvegan commented Apr 29, 2024

As you mentioned in our chat, this Peek a live code-walkthrough of the new OP Stack fault proof code! video is helpful

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-request docs updates requested by community or OP collective documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants