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

Improving Akash Documentation Structure and Naming #43

Closed
aktdenis opened this issue Feb 29, 2024 · 2 comments
Closed

Improving Akash Documentation Structure and Naming #43

aktdenis opened this issue Feb 29, 2024 · 2 comments
Assignees

Comments

@aktdenis
Copy link

aktdenis commented Feb 29, 2024

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

  1. Intro to Akash, where we provide an overview of the Supercloud concept
    items:
  • Intro to Akash
  • Supercloud Architecture
  1. Getting Started
    items:
  • SDL
  • Tokens and Wallets
  • Technical Support
  1. 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.
  1. Network
    items:
  • Akash Nodes
  • Network Features
  • Validators
  • Testnets
  1. 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


  1. 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.
  1. 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:
Screenshot 2024-02-29 at 15 08 38

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?

@aktdenis
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants
@aktdenis and others