Skip to content

Restructure Serverless docs and rewrite /serverless/endpoints/ section #227

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

Merged
merged 32 commits into from
Apr 18, 2025

Conversation

muhsinking
Copy link
Collaborator

@muhsinking muhsinking commented Apr 16, 2025

Overview

This PR implements a comprehensive restructuring of the Serverless documentation, focusing on improving navigation, consistency, and user experience. The changes include case standardization, category reordering, and implementation of proper URL redirects.

It also implements a full rewrite of all topics in the /serverless/endpoint/ folder, including many deletions to reduce content duplication.

Changes

Serverless Documentation Structure

  • Reordered Serverless documentation categories for better logical flow
  • Moved all subdirectories out of /serverless/workers/
  • Standardized case usage across all documentation (e.g., "Endpoint" → "endpoint")
  • Updated category positions in sidebar navigation
  • Improved category descriptions and labels
  • Moved endpoint reference documentation from /serverless/references/ to /serverless/endpoints/
  • Reorganized endpoint documentation for better flow and discoverability

URL Redirects

  • Implemented comprehensive redirect system for Serverless documentation paths
  • Added redirects for:
    • /serverless/workers/development//serverless/development/
    • /serverless/workers/handlers//serverless/handlers/
    • /serverless/workers/vllm//serverless/vllm/
    • /serverless/references//serverless/endpoints/
    • /serverless/endpoints/get-started/serverless/endpoints/send-requests
    • /serverless/endpoints/job-operations/serverless/endpoints/operations

Content Improvements

  • Rewrote endpoints overview with clearer explanations and better organization
  • Improved job states documentation with clearer explanations
  • Enhanced request sending documentation with better examples and structure
  • Merged glossary.md info into the endpoint settings/monitoring docs
  • Improved operations documentation with better formatting and clarity; merged and deleted job-operations.md to reduce content duplication
  • Updated handler functions documentation with clearer examples and structure
  • Enhanced local testing documentation with comprehensive flag explanations
  • Fixed inconsistent capitalization throughout docs

Technical Details

  • Modified category JSON files to reflect new structure
  • Standardized documentation formatting and terminology
  • Updated internal links to reflect new documentation structure
  • Added redirects for old paths to docusaurus.config.js to maintain backward compatibility
  • Updated package.json to include @docusaurus/plugin-client-redirects

Testing

  • Verified all redirects work as expected
  • Checked all links and references are properly updated
  • Verified all internal links are working correctly
  • Checked documentation formatting and consistency

Impact

This restructuring improves the overall user experience by:

  • Making documentation navigation more intuitive
  • Ensuring consistent terminology throughout
  • Maintaining backward compatibility through redirects
  • Providing clearer organization of Serverless-related content
  • Making endpoints documentation more accessible and comprehensive
  • Providing a clearer learning path for endpoint-related concepts
  • Enhancing the discoverability of handler functions and development guides
  • Improving the clarity and usability of local testing documentation

Copy link

vercel bot commented Apr 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 18, 2025 3:07pm

@muhsinking muhsinking changed the title Serverless docs restructure Restructure Serverless docs Apr 16, 2025
@muhsinking muhsinking changed the title Restructure Serverless docs + /serverless/endpoints improvements Restructure Serverless docs and rewrite /serverless/endpoints/ section Apr 17, 2025
@muhsinking muhsinking marked this pull request as ready for review April 18, 2025 00:30
Copy link
Collaborator

@Yhlong00 Yhlong00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good to me, left some comments

@muhsinking muhsinking merged commit e746dad into main Apr 18, 2025
2 checks passed
@muhsinking muhsinking deleted the serverless-restructure branch April 18, 2025 23:40
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.

2 participants