This is the mandatory structure for a grand application template. Please copy it and make it yours.
Please note that this template ist mandatory for the grant application in
Application Status
Status: New
Last updated: 29.08.2024
**Submited by : Susan Ploetz [email protected]
Team:
Approved Budget (in h): 105
Used Budget (in h): 0
Planned Delivery: 25.09.2024
Specify the funding category
The categories are Open Source Development, Research and Education, Community Growth, Culture and Art. In which Category is your application?
Research and Education, Community Growth, and support for Open Source Developement
Application Title
aeternity documentation consolidation and synchronization project
Applicant
Intro post on aeternity forum here
My name is Susan,
I am an experience/event designer, and part of my design work has been building live action simulations around speculative AI technologies, Climate change scenarios and Robotics/Human Robot Interaction design. I’m a published author of various different types of art and writing projects. I’ve been involved in the blockchain world since 2017, mostly recently as Head of Community, Customer Experience and Compliance at Swarm Markets where I did many things including onboarding design, and maintainance of various documentation for users and devs, including their GitBook. I have experience as a Social, Content and Community Manager, Project manager, Whitepaper editor, and in Investor Relations, amongst the many hats I’ve worn in many projects.
Value Application
What will become better and why? Why is your work beneficial for the aeternity ecosystem? (Please describe the impact of your project. How will your work impact the larger aeternity ecosystem? How does a successful contribution of your project look like?)
This project aims to significantly enhance the accessibility, usability, and impact of the æternity ecosystem’s documentation, thereby providing substantial value in several key areas:
Educational Resource: By centralizing and organizing the documentation, this project will improve access for developers and other stakeholders. It will make it easier for them to learn about the æternity blockchain, its tools, and how to contribute, aligning with the goals of education and knowledge dissemination within the ecosystem.
Technical Documentation: The project involves curating and synchronizing technical documentation, a crucial educational resource for developers, researchers, and the broader community. This will ensure that accurate, up-to-date information is readily available, supporting informed participation in the æternity ecosystem.
Community Growth:
• Improving Developer Onboarding: By making documentation more accessible and centralized, the project will directly support the onboarding of new developers and contributors, which is essential for fostering community growth.
• Engagement: A well-organized and easily navigable documentation platform will likely lead to increased engagement within the community. Users and contributors will be able to find the information they need more easily, encouraging more active participation and collaboration.
Definition of Terms
What exactly are we talking about? Please describe your project.
This project involves the consolidation and synchronization of æternity’s decentralized documentation across various GitHub repositories into a unified and accessible GitBook format. The process will include the following key tasks:
Initial Planning and Structure Design:
• Review and analyze existing documentation across multiple GitHub repositories and current documentation websites.
• Design a unified structure for the GitBook that ensures logical categorization and easy navigation for users.
2. Setup and GitBook Sync Configuration:
• Install and configure the GitBook GitHub app with the necessary permissions for the repositories to be synced.
• Set up GitBook Sync for each relevant repository, linking the appropriate GitBook space with the corresponding GitHub repository and selecting the correct branch for synchronization.
• Perform an initial sync of content from GitHub to GitBook (or vice versa) for each repository to ensure that the most up-to-date documentation is reflected in GitBook.
• If necessary, prioritize and phase the sync process, beginning with the most critical repositories.
3. Content Migration and Organization:
• Migrate existing documentation from various sources into the newly structured GitBook.
• Organize, link, and optimize the content within GitBook to create a cohesive user experience.
4. Design Integration:
• Collaborate with a web designer to apply a professional and cohesive design to the GitBook, enhancing readability and user experience.
5. Final Testing and Documentation:
• Conduct thorough testing of the entire system to ensure that everything works as expected, including verification that changes in GitHub are accurately reflected in GitBook.
• Create detailed documentation and guidelines for the client’s team on maintaining and updating the system.
6. Project Management and Communication:
• Provide regular updates, maintain clear communication throughout the project, and adjust plans as necessary based on community/dev feedback.
Status Quo
What is now?
The current state of æternity’s documentation is highly fragmented and scattered across multiple GitHub repositories. This decentralized organization, while aligned with the principles of the platform, results in significant challenges for users attempting to access and navigate the documentation. For those who prefer not to delve into the complexities of GitHub repositories, some documentation is available on the web; however, this information is presented in a fragmented and inconsistent manner, making it difficult to find comprehensive and cohesive resources.
Required Work
Steps to get to the goal…
Please list milestones and deliverables of your project.
M1: Initial Planning and Structure Design
D1: A detailed plan and structure for the unified documentation repository, ensuring logical categorization and easy navigation.
• Estimated Time: 10 hours
• Start Date: 02.09.24
• Completion Date: 03.09.24
M2: Setup and GitBook Sync Configuration
D2: GitHub Integration Setup: Installation and configuration of the GitBook GitHub app with necessary permissions.
• Repository Sync Setup: Establishing GitBook Sync for all relevant repositories.
• Initial Sync: Successfully synchronizing the first batch of content from GitHub to GitBook.
• Estimated Time: 35 hours
• Start Date: 04.09.24
• Completion Date: 11.09.24
M3: Content Migration and Organization
D3: Migration of existing documentation into the newly structured GitBook.
• Organization and optimization of content within GitBook for a seamless user experience.
• Estimated Time: 20 hours
• Start Date: 12.09.24
• Completion Date: 16.09.24
M4: Design Integration
D4: Collaboration with a web designer to implement a cohesive and professional design within GitBook.
• Estimated Time: 15 hours
• Start Date: 16.09.24
• Completion Date: 17.09.24
M5: Final Testing and Documentation
D5: Thorough testing of the documentation system to ensure synchronization accuracy between GitHub and GitBook.
• Creation of detailed guidelines for future maintenance and updates.
• Estimated Time: 10 hours
• Start Date: 18.09.24
• Completion Date: 19.09.24
M6: Project Management and Communication
D6: Regular project updates and clear communication with stakeholders.
• Adjustments to the project plan as necessary based on feedback.
• Estimated Time: 15 hours (spread across the project duration)
• Start Date: 02.09.24
• Completion Date: 25.09.24
Estimate
Your time estimate in hours for the Project. Please do not put here Prices!
Please list the estimated timeline by milestones and releases of your project.
105 hours
Known Limitations
Will everything work as expected to solve the original problem?
The primary challenges for this project include managing the large number of repositories on GitHub and determining which of them need to be synced with the GitBook. Ensuring that the synchronization process occurs smoothly, with the content being presented in a readable and visually appealing format, is critical. Additionally, successful coordination with the designer to apply design elements effectively within GitBook is essential for achieving a cohesive and professional final product.
Outlook
What happens after this project is completed?
Upon completion of this project, the centralized and well-organized documentation will serve as a robust resource for both new and existing members of the æternity ecosystem. This project is expected to enhance the onboarding process for developers and improve overall community engagement by making critical information more accessible and user-friendly.
Looking forward, regular updates and maintenance will be necessary to keep the documentation current with any developments in the æternity ecosystem. There may also be opportunities to expand the documentation with additional resources, such as tutorials, FAQs, and best practices, further enriching the community’s educational assets. Continuous collaboration with the design team will ensure that the documentation remains not only functional and easy to use but also visually appealing.
Do you plan to populate your project? (For example creating a micro-web-page, social media updates, blog-posts, video-materials.)
I plan to collaborate with the communications team to make a community announcement debuting the new GitBook. This would ensure that the community is informed about the updated documentation project.
Publishment
Please confirm that your research and development will be published free of any proprietary license (open-source, open-access). Please provide a link to the GitHub repository of your open source project.
Maintainance
Please confirm that your research and development code will be maintained with bug fixing and new updates free of charge for at least one year after publishing it.