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

Polykey-Docs 1.0 Epic: Development of Theory Documentation #81

Open
7 tasks
CryptoTotalWar opened this issue Jun 30, 2024 · 1 comment
Open
7 tasks
Assignees
Labels
design Requires design (architecture, protocol, specification and task list requires further work) documentation Improvements or additions to documentation enhancement New feature or request r&d:polykey:supporting activity Supporting core activity

Comments

@CryptoTotalWar
Copy link
Contributor

CryptoTotalWar commented Jun 30, 2024

WIP

Goals and Objectives

Objective: Develop and enhance the Theory section of Polykey’s documentation to provide users with in-depth theoretical knowledge that supports their understanding and use of Polykey. This documentation will delve into the concepts and principles underlying the practical applications covered in the How-To Guides and Tutorials.

Specific Goals:

  • Depth and Clarity: Ensure the Theory documentation offers comprehensive insights into the foundational theories that underpin Polykey's functionalities.
  • Support Practical Use: Link theoretical content to practical examples where possible, to help users connect theory with practice.
  • Engagement and Accessibility: Make complex theoretical content engaging and accessible through clear writing, effective organization, and appropriate visual aids.

Current Documentation Evaluation

  • Content Audit: Conduct a thorough review of existing Theory documentation to assess its accuracy, relevance, and completeness.
  • User Feedback: Gather feedback from users about the current Theory content to identify gaps and areas for improvement.
  • Technical Review: Involve subject matter experts to ensure the content is technically sound and up-to-date.

Potential and Confirmed Topics for Theory

This section will serve as a dynamic area for brainstorming potential topics, evaluating their relevance and demand, and confirming topics for development.

Evaluation Process

  • Review current state of Theory documentation & Create subsequent sub-tickets and necessary discussion
  • Review excalidraw documentation to evaluate other topics for covering

Topics Under Consideration:

  • Cryptographic Fundamentals: Explore the cryptographic principles that secure data within Polykey.
  • Security Models: Discuss various security models and architectures that influence Polykey’s design.
  • Network Security Protocols: Detailed explanation of the protocols Polykey uses to secure communication across networks.
  • Distributed Systems and Consensus Algorithms: An in-depth look at how Polykey manages distributed systems.

Confirmed Topics:

  • Principles of Secret Management: Discuss the theoretical underpinnings of secret management within Polykey and its applications.

Specifications for Implementation

Once a topic is confirmed:

  • Detailed Outline: Develop a detailed outline for each Theory document, specifying key concepts, expected structure, and supporting materials.
  • Resource Allocation: Determine the resources needed for each topic, including technical writers, subject matter experts, and graphic designers for diagrams and visual aids.
  • Development Timeline: Establish timelines for the writing, reviewing, and publishing phases.

Linking and Tracking

  • Sub-Issues for Each Topic: Create detailed sub-issues for each confirmed theory topic. These sub-issues will outline specific tasks related to content development and ensure detailed tracking and accountability.
@CryptoTotalWar CryptoTotalWar added design Requires design (architecture, protocol, specification and task list requires further work) documentation Improvements or additions to documentation enhancement New feature or request epic Big issue with multiple subissues labels Jun 30, 2024
@CryptoTotalWar CryptoTotalWar self-assigned this Jun 30, 2024
@CryptoTotalWar CryptoTotalWar changed the title Polykey-Docs 1.0: Development of Theory Documentation Polykey-Docs 1.0 Epic: Development of Theory Documentation Jun 30, 2024
Copy link

linear bot commented Jun 30, 2024

@CMCDragonkai CMCDragonkai added r&d:polykey:supporting activity Supporting core activity and removed epic Big issue with multiple subissues labels Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design Requires design (architecture, protocol, specification and task list requires further work) documentation Improvements or additions to documentation enhancement New feature or request r&d:polykey:supporting activity Supporting core activity
Development

No branches or pull requests

2 participants