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

Refractor/docs #1793

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

Refractor/docs #1793

wants to merge 16 commits into from

Conversation

GigaHierz
Copy link
Contributor

  • refactor architecture so URLs are coherent with sidebar

  • Overview page

    • add Token Duality
    • 1 second block finality
    • mobile first -> mobile focused
    • remove carbon negative and ultra green money
    • replace videos
  • Using Celo section

    • Flatten section - bring files out of Holder Section
    • Add Updated Protocol Section
      • Update Penalties based on Forum Post and add info that it is a WIP with link to Forum
      • Update/ Flatten consensus based on Forum Post and add info that it is a WIP with link to Forum
      • Update Community Fund based on Forum Post and add info that it is a WIP with link to Forum
      • Update Carbon Offsetting Fund based on Forum Post and add info that it is a WIP with link to Forum
      • Unify files for Transactions (merge gas fee content into fee abstraction, add gas price calculations)
      • Add Token Duality to the Celo Token Page
    • Unify all Governance files in one folder here, add links to forum posts for current status
    • Remove Wallet Section
    • Remove recovery Section
    • Update Bridging section
    • Update DEX -> Exchange section
    • Bring back the Glossary and terms (based on Optimism docs)
  • Joining Celo Section

    • Update links to direct to Dapp showcase and not CPG page
    • merge developer & founder to Builer in overview page
    • Add link to Regional DAO Council Forum post
    • flatten guidelines
    • remove outdated Grant Playbook
    • move ALL contributor guides here

viral-sangani and others added 16 commits March 21, 2025 16:35
Removed outdated content and improved clarity by consolidating information on Celo's features. Key changes include the addition of "Fast Transactions" and "Mobile-Focused Approach" sections, while updating the scalability metric to reflect over 250,000 daily active users. The structure has been streamlined to enhance readability and accessibility for users.
This commit introduces significant changes to the Celo documentation, including the addition of new sections and the restructuring of existing content for improved clarity and navigation. Key updates include:

- Renaming and reorganizing sidebar items to enhance user experience.
- Creating new documentation pages for "Celo Governance," "Bridges," and "Asset Management," among others.
- Updating links and references to ensure consistency and accuracy across the documentation.
- Removing outdated content and consolidating information to streamline the user journey.

These changes aim to provide a more cohesive and accessible resource for users engaging with the Celo ecosystem.
This commit introduces a new welcome page for the Celo documentation, outlining Celo's mission and providing an overview of the ecosystem. Key additions include sections on getting started, Celo basics, community engagement, and resources for developers and validators. The welcome page aims to enhance user onboarding and provide a comprehensive introduction to Celo's offerings.
This commit introduces a comprehensive set of new documentation pages covering various aspects of the Celo L1 protocol, including architecture, governance, identity, and transaction mechanisms. Key additions include:

- Overview of Celo L1 architecture and its mobile-friendly design.
- Detailed explanations of consensus mechanisms, validator operations, and governance proposals.
- Insights into identity management, including ODIS and key management practices.
- Documentation on transaction types, gas pricing, and escrow contracts.

These updates aim to enhance the clarity and accessibility of Celo's technical documentation, providing users with essential resources to understand and engage with the Celo ecosystem effectively.
This commit introduces significant changes to the Celo documentation, including the removal of outdated guides and the addition of new contributor resources. Key updates include:

- Deletion of the "Fundraising" and "Grant Playbook" guides to streamline content.
- Introduction of new sections for "Code Contributors," "CIP Contributors," and "Documentation Contributors" to enhance community engagement.
- Reorganization of the sidebar to reflect these changes, improving navigation and accessibility for users.

These updates aim to provide a more cohesive and user-friendly resource for contributors engaging with the Celo ecosystem.
…avigation

This commit includes various updates across the Celo documentation, focusing on enhancing link accuracy and content clarity. Key changes include:

- Updated links to governance and protocol sections for consistency.
- Improved references to the Celo ecosystem, including validator and transaction documentation.
- Streamlined content in several sections to enhance user understanding and accessibility.

These updates aim to provide a more cohesive and user-friendly experience for those engaging with the Celo platform.
This commit introduces a comprehensive update to the Celo release process documentation, adding detailed guides for various components including Smart Contracts, Blockchain Client, CeloCLI and ContractKit, Attestation Service, and Celo Oracles. Key changes include:

- New documentation files outlining the release processes for each component.
- A structured sidebar category for "Release Process" to improve navigation and accessibility.
- Consolidation of existing content to ensure clarity and consistency across the documentation.

These updates aim to provide contributors with clear guidelines and resources for engaging with the Celo platform's release processes effectively.
This commit streamlines the Celo documentation sidebar by removing several outdated categories, including "Explorers," "Wallets," and "Indexers." Key changes include:

- Deletion of specific documentation links and categories that are no longer relevant.
- Simplification of the sidebar structure to enhance navigation and focus on current content.

These updates aim to provide a cleaner and more efficient user experience for those engaging with the Celo platform.
- add info from forum to protocol section
@GigaHierz GigaHierz requested review from a team as code owners March 22, 2025 00:22
@GigaHierz GigaHierz requested review from Kourin1996 and alecps and removed request for a team March 22, 2025 00:22
Copy link

netlify bot commented Mar 22, 2025

Deploy Preview for celo-docs failed.

Name Link
🔨 Latest commit 18b3f16
🔍 Latest deploy log https://app.netlify.com/sites/celo-docs/deploys/67de02adfc12ed0008bbe7a7

@GigaHierz GigaHierz requested review from lvpeschke and removed request for a team, Kourin1996 and alecps March 22, 2025 00:34
@GigaHierz GigaHierz requested a review from katen0ra March 22, 2025 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants