MatrixAI / Polykey-Docs

Documentation for Polykey
https://polykey.com/docs/
GNU General Public License v3.0
1 stars 5 forks source link

Revamp Polykey Documentation Home Page #96

Open CryptoTotalWar opened 3 months ago

CryptoTotalWar commented 3 months ago

Description

This ticket aims to address and improve the current state of the Polykey documentation home page. The home page, positioned under the 'Getting Started' category, serves as the primary entry point to the documentation. The goal is to enhance its effectiveness in guiding new users and providing a comprehensive overview of Polykey's functionalities, including the CLI and client library.

Objectives and Notes

Placeholder for Detailed Updates

Conclusion

The purpose of this ticket is to initiate the revamp of the Polykey documentation home page, making it more intuitive and informative for users at their first point of contact with Polykey documentation. This revamp will be carried out in phases, starting with quick fixes to enhance current content and planning more comprehensive updates in the future. This iterative process will ensure the home page remains relevant and useful as Polykey continues to evolve. We'll close this ticket once we think it has an achieved a deployable and effective version.

linear[bot] commented 3 months ago

PRO-207 Revamp Polykey Documentation Home Page

CryptoTotalWar commented 3 months ago

We're presenting a new class of vehicles for transport of secrets. We're also providing the digital highways and tolls. We're even providing the deriver's license! The Getting started guide is like driving school, learning how to drive the new vehicle class.

The Home Page could use less text and more media.

The following are some notes i took of what content we may want to include in the home page.