You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
During wg-website meetings, we discussed the possibilities of organizing Akash Docs and Engineering Docs.
A simple solution we mentioned during the meeting would be to add labels above each of the category;
Akash Docs
menu item
menu item
...
Engineering Docs
menu item
menu item
...
An easy fix that would visually separate the Docs in half.
But digging deeper I feel some concepts or menu items fit in the same group - but are currently separated or located in a sub-menu section. That's why I'm proposing to reorganize the menu and divide it into groups, with a dedicated label above each group.
I believe this approach would provide clarity and guidance for users.
Structure:
Starting of with
Intro to Akash, where we provide an overview of the Supercloud concept
items:
Intro to Akash
Supercloud Architecture
Getting Started
items:
SDL
Tokens and Wallets
Technical Support
Services
items:
Deployments
Providers
Guides Note: We have to evaluate the relevance of outdated guides (e.g., Chia and Kava) and consider linking external guides created by users. That could live in the "Community contributions" page - but that's another issue.
Network
items:
Akash Nodes
Network Features
Validators
Testnets
Core Documentation
items:
Provider Service & Sub Services
Akash Providers Operators
Akash Nodes
Akash App
Development Environment
Code Contributors Guidelines
End to End Testing Provider
Akash API
Other Resources
items:
-Experimental
Security
Containers
Marketplace
Payments
Authentication
Akash Mainnet8 Upgrade Note: Some of the items from this group could easily be moved to a dedicated group. Like "Marketplace" for example.
Support Note: Support is mentioned 2 times in the menu. First in the "getting started" and as the last menu item
Attaching a mockup of the structure above here:
As you see some of the items are renamed. Which opens up another topic. And that is:
Naming:
Next to organizing items, the Akash Docs (items) would benefit from some naming improvements. Stating some of the possible improvements below.
at the section "Engineering notes" each item starts with Akash. It seems redundant and repetitive and does not align with the rest of the items in the menu. For example we could shorten "Akash Code Contributors Policies and Standards" to "Code Contributors Guidelines." Same goes for the rest of the items in the "Engineering notes" section.
from a first glance we rarely or don't even mention "Supercloud". We could add it to the item "Architecture" so it says "Supercloud Architecture"
"Testnet", renaming to "Testnets" (plural form)
We have to bring a final decision on how to name the "Engineering Notes/Docs". I tried a couple and ended up liking something with a word "Core" inside. Since I've heard Arthur often talk about core product, platform etc. - so, here is my take: "Core Documentation" or "Core Network Documentation. @zachhorn what are your thoughts?
The text was updated successfully, but these errors were encountered:
This issue is not finalized but serves as a starting point for further discussion and refinement. Feel free to share your thoughts and suggestions. cc @brewsterdrinkwater
During wg-website meetings, we discussed the possibilities of organizing Akash Docs and Engineering Docs.
A simple solution we mentioned during the meeting would be to add labels above each of the category;
Akash Docs
...
Engineering Docs
...
An easy fix that would visually separate the Docs in half.
But digging deeper I feel some concepts or menu items fit in the same group - but are currently separated or located in a sub-menu section. That's why I'm proposing to reorganize the menu and divide it into groups, with a dedicated label above each group.
I believe this approach would provide clarity and guidance for users.
Structure:
Starting of with
items:
items:
items:
Note: We have to evaluate the relevance of outdated guides (e.g., Chia and Kava) and consider linking external guides created by users. That could live in the "Community contributions" page - but that's another issue.
items:
items:
items:
-Experimental
Note: Some of the items from this group could easily be moved to a dedicated group. Like "Marketplace" for example.
Note: Support is mentioned 2 times in the menu. First in the "getting started" and as the last menu item
Attaching a mockup of the structure above here:
As you see some of the items are renamed. Which opens up another topic. And that is:
Naming:
Next to organizing items, the Akash Docs (items) would benefit from some naming improvements. Stating some of the possible improvements below.
at the section "Engineering notes" each item starts with Akash. It seems redundant and repetitive and does not align with the rest of the items in the menu. For example we could shorten "Akash Code Contributors Policies and Standards" to "Code Contributors Guidelines." Same goes for the rest of the items in the "Engineering notes" section.
from a first glance we rarely or don't even mention "Supercloud". We could add it to the item "Architecture" so it says "Supercloud Architecture"
"Testnet", renaming to "Testnets" (plural form)
We have to bring a final decision on how to name the "Engineering Notes/Docs". I tried a couple and ended up liking something with a word "Core" inside. Since I've heard Arthur often talk about core product, platform etc. - so, here is my take: "Core Documentation" or "Core Network Documentation. @zachhorn what are your thoughts?
The text was updated successfully, but these errors were encountered: