docs: Rewrite Hosting documentation for quality and consistency#602
Open
promptless[bot] wants to merge 2 commits intomainfrom
Open
docs: Rewrite Hosting documentation for quality and consistency#602promptless[bot] wants to merge 2 commits intomainfrom
promptless[bot] wants to merge 2 commits intomainfrom
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:- https://docs.runpod.io/sdks/graphql/*
- https://docs.runpod.io/hosting/*
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)
.long_term_context/style/client_style_guide.md.long_term_context/doc_workflow/client_instructions.md.long_term_context/product_knowledge/product_overview.md.claude/style-guide.mdsdks/graphql/configurations.mdxsdks/graphql/manage-endpoints.mdxsdks/graphql/manage-pod-templates.mdxsdks/graphql/manage-pods.mdxhosting/overview.mdxhosting/partner-requirements.mdxhosting/burn-testing.mdxhosting/maintenance-and-reliability.mdxpods/manage-pods.mdxpods/overview.mdxpods/templates/overview.mdxsdks/python/overview.mdxsdks/python/apis.mdxreferences/graphql-spec.mdxsdks/go/overview.mdxsdks/javascript/overview.mdxsdks/go/endpoints.mdxAgent Response
Tip: Enable auto-create PR in your Docs Collection to publish suggestions automatically 🤖