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

Expand Documentation #30

Closed
getpinga opened this issue Dec 14, 2023 · 0 comments
Closed

Expand Documentation #30

getpinga opened this issue Dec 14, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@getpinga
Copy link
Contributor

We are actively seeking contributors to help expand our project documentation. Our goal is to create a thorough and user-friendly guide that covers various aspects of configuring and running a TLD registry in compliance with ICANN requirements.

Key areas where we need detailed documentation include:

  1. Architecture Overview: Insight into the system architecture, explaining how different components interact and the rationale behind design choices.

  2. Possible Settings and Configurations: Detailed guidance on various settings and configurations, providing users with the knowledge to tailor the system to their specific needs.

  3. Registrar Management: Information on managing registrar operations, addressing common registrar questions, and best practices for smooth functioning.

  4. Component Details: In-depth explanations of different components, how they can be configured, and their role in the overall system.

  5. ICANN Compliance: Guidance on how to ensure that the registry operations align with ICANN requirements, including necessary procedures and standards.

We believe that robust documentation is crucial for empowering users and fostering a collaborative community. Whether you have expertise in one of these areas or are interested in researching and writing about them, your contribution would be immensely valuable.

Please feel free to reach out if you have any questions, or jump straight into contributing by picking a section that aligns with your interest or expertise. We appreciate any level of involvement, whether it's writing a complete section or simply proofreading and suggesting improvements.

Thank you for considering contributing to our project's documentation. Your efforts will help make this tool more accessible and understandable to everyone looking to run their TLD registry.

@getpinga getpinga added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Dec 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant