Skip to content

[NEW] Guidelines for Contributing Deployment Guides to Akash Documentation #572

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

Closed
HoomanDgtl opened this issue Mar 17, 2025 · 0 comments
Closed
Assignees

Comments

@HoomanDgtl
Copy link
Contributor

To ensure high-quality documentation and streamline the review process, contributors must adhere to the following guidelines when adding new deployment guides:


1. One Application per Pull Request (PR)

  • Submit a single PR containing a complete guide for one application only.
  • Avoid bundling multiple applications into one PR to simplify review, testing, and feedback.

2. Prioritize High-Demand Applications

  • Avoid creating guides for applications with low user demand or niche use cases.
  • Before drafting a guide, conduct market research to validate demand (e.g., check community forums, GitHub issues, or user surveys).
  • Focus on applications that are:
    • Widely used in the ecosystem.
    • Frequently requested by users.
    • Relevant to current trends or common use cases.

3. Conduct Market Research

  • Research the target audience to identify the most needed guides.
  • Use the following methods to gather insights:
    • Analyze community feedback (e.g., Discord, Slack, or forum discussions).
    • Review existing documentation requests or feature proposals.
    • Leverage analytics or user polls to prioritize applications.
  • Propose high-impact guides that address real user needs.

By following these guidelines, contributors ensure that documentation remains organized, relevant, and user-focused, while streamlining collaboration and review workflows.

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

No branches or pull requests

2 participants