Skip to content

docs: Rewrite Hosting documentation for quality and consistency#602

Open
promptless[bot] wants to merge 2 commits intomainfrom
promptless/hosting-docs-rewrite
Open

docs: Rewrite Hosting documentation for quality and consistency#602
promptless[bot] wants to merge 2 commits intomainfrom
promptless/hosting-docs-rewrite

Conversation

@promptless
Copy link
Copy Markdown
Contributor

@promptless promptless bot commented Mar 31, 2026

Open this suggestion in Promptless to view citations and reasoning process

Restructured and improved all four Hosting documentation pages to match the quality standards of the rest of the docs. Each page now has proper frontmatter with descriptions, concise intro paragraphs, clear section headings, proper use of callouts, and Next steps sections. The burn-testing page was transformed into a step-by-step guide using the Steps component.

Trigger Events

Web UI: Two sections of our docs still need to be rewritten. The content should be relatively up to date, but isn't aligned with the quality/structure of the rest of our documentation. Here are the sections:

Read through existing documentation to get a sense for the higher quality and structure that these two pages should be rewritten to match. This will require substantial rewriting and restructuring.



Promptless Research (21 files)

  • Viewed .long_term_context/style/client_style_guide.md
  • Viewed .long_term_context/doc_workflow/client_instructions.md
  • Viewed .long_term_context/product_knowledge/product_overview.md
  • Viewed .claude/style-guide.md
  • Viewed sdks/graphql/configurations.mdx
  • Viewed sdks/graphql/manage-endpoints.mdx
  • Viewed sdks/graphql/manage-pod-templates.mdx
  • Viewed sdks/graphql/manage-pods.mdx
  • Viewed hosting/overview.mdx
  • Viewed hosting/partner-requirements.mdx
  • Viewed hosting/burn-testing.mdx
  • Viewed hosting/maintenance-and-reliability.mdx
  • Viewed pods/manage-pods.mdx
  • Viewed pods/overview.mdx
  • Viewed pods/templates/overview.mdx
  • Viewed sdks/python/overview.mdx
  • Viewed sdks/python/apis.mdx
  • Viewed references/graphql-spec.mdx
  • Viewed sdks/go/overview.mdx
  • Viewed sdks/javascript/overview.mdx
  • Viewed sdks/go/endpoints.mdx

Agent Response

I've completed the substantial rewrite of both documentation sections. Here's a summary of the changes:

GraphQL API Documentation Rewrite

Suggestion: https://app.gopromptless.ai/suggestions/ef0c07dc-f163-401e-a971-8ca8ce3b5646

Restructured all four pages:

  • configurations.mdx → Overview: Transformed from a list of parameter definitions into a proper overview page with intro, quick start example, CardGroup navigation, and a reference table for common input fields.
  • manage-pods.mdx: Added proper intro, quick reference table, cleaner section organization, and consistent code example formatting with tabs.
  • manage-pod-templates.mdx: Added intro, quick reference table, required fields documentation, and better section structure.
  • manage-endpoints.mdx: Added intro, quick reference table, configuration options documentation, and consistent formatting.

Hosting Documentation Rewrite

Suggestion: https://app.gopromptless.ai/suggestions/0f512c56-6934-4ccc-b642-a7bc9e57d015

Restructured all four pages:

  • overview.mdx: Added proper intro, CardGroups for navigation, summary table for existing hosts, and clear sections for different audiences.
  • burn-testing.mdx: Transformed into a proper step-by-step guide using the Steps component with numbered steps, added "What to watch for" section.
  • maintenance-and-reliability.mdx: Added clearer intro, structured maintenance rules in tables, improved reliability calculation documentation.
  • partner-requirements.mdx: Improved intro, better section organization, consistent table formatting, clearer effective dates section.

All pages now follow your documentation standards with descriptive frontmatter, concise intro paragraphs, clear section headings, proper use of callouts (Note, Warning), and Next steps sections.


Tip: Enable auto-create PR in your Docs Collection to publish suggestions automatically 🤖

@mintlify
Copy link
Copy Markdown

mintlify bot commented Mar 31, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
runpod-docs 🟢 Ready View Preview Mar 31, 2026, 12:51 PM

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.

1 participant