[Tracking] Documentation 2.0 migration

[cloud-j-luna]

This issue serves the purpose of tracking the work needed to be done to migrate the old documentation to the new structure.

Outdated:

• https://docs.akash.network/providers/build-a-cloud-provider/akash-provider-checkup
• https://docs.akash.network/deploy/tls-termination-of-akash-deployments #2 #3

Won't Migrate:

• https://docs.akash.network/other-resources/archived-resources/akash-v0.18.0-cli-release-notes
• https://docs.akash.network/other-resources/archived-resources/provider-upgrade

Enhancements:

• [x] Code syntax highlight
• [x] Tags and categories for pages
• [x] Social icons on top navigation

Acceptance Criteria:

• [x] New documentation website using Hugo
• [x] Support for localization
• [ ] Old documentation website archived
• [ ] New docs repository transferred to akash-network organization

This issue will be updated as we progress and find improvements to be made.

[brewsterdrinkwater]

the Github, Discord, and Twitter links should live in the nav bar, similar to https://docs.solana.com/developers

[brewsterdrinkwater]

Please make sure to migrate ALL items from Gitbook to Hugo. We can remove old artifacts and look to address any potential holes in documentation during another working group session.

[aktdenis]

Luna, first of all thank you for your efforts. Here is my feedback:

• favicon seems to be condensed, imo tab name should say: Akash Documentation, not Official Documentation.
• i'm thinking if we should skip the hero image part and the button "start here", unless this plays a certain role for users. i would suggest we take the user directly to docs and avoid/skip this part where user has to click either "start here" or "documentation"
• on the other hand the first page of docs should be visually appealing and it should spark interest in visitors/users. why not combine the page with big image and the first page of docs? - i'm sharing some design drafts at the end of this feedback.
• overall design direction should follow the established and establishing design presence of Akash. This means we use certain typography, rules within typography, colors and imagery/illustrations. Keeping everything light and minimalistic will def. help.
• any thoughts on adding existing libraries such as tailwind, radix ui, chakra, shadcn, bootstrap? it might help when the docs grow and other users would like to contribute. (was talking with front-end dev contributors for console and website and all prefer some sort of a library - meaning we shouldn't custom code everything)

[aktdenis]

[aktdenis]

Here are couple of drafts for the starting page. Also providing an example of content page, to get a feeling of typography treatment, breaks, links etc.

[Andree37]

hey @aktdenis firstly thank you for your feedback I have fixed the minor issues with the search, bottom bar icons and favicon as seen here:

About the design system you mentioned, is there any resource you can share that allows us to inspect the font, spacings, or the sketches and icons you showed? :)

Also to mention that hugo is a static site generator that works with markdown, it is also possible to add CSS libraries like tailwind but quite impossible to add Chakra and other React based component libraries. Currently, we support Scss to style the markdown but I do believe it is also possible to enable tailwind if we find fit.

[aktdenis]

hey @Andree37 , great! i'm sharing the figma drafts here: https://www.figma.com/file/S63tyfwHvDJ9CuDeYrK8k8/akash-docs?node-id=48%3A2666&t=vyQJTtDAusynoKBA-1

please let me know if you need anything else, here to support you.👋🏼

[aktdenis]

One more thing we discussed in one of our docs meetings. Would be great to be able to copy code snippets with a single click.

Code example: https://codepen.io/foxbeefly/pen/dyWbQgJ

Live example: https://fly.io/docs/apps/deploy/

[cloud-j-luna]

Hey @aktdenis that is already implemented and available on the development version 😄

[brewsterdrinkwater]

here is the docs 2.0 docker file https://github.com/akash-network/new-docs. Migration from Luna and his team is complete.

Piyush and his team will add the updated docs to the revamped website.