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

Implement Versioned Documentation #1230

Open
akshit-vadodariya-st8 opened this issue Dec 3, 2024 · 0 comments
Open

Implement Versioned Documentation #1230

akshit-vadodariya-st8 opened this issue Dec 3, 2024 · 0 comments

Comments

@akshit-vadodariya-st8
Copy link

Feature Request: Introduce versioned documentation for Deno to support different releases and ensure users can access documentation relevant to their specific Deno versions.

Details:

  • Current Situation: The Deno documentation currently reflects the latest release, which may not align with older versions that some projects still utilize.
  • Proposed Solution: Implement a versioning system within the documentation site, allowing users to select and view documentation corresponding to specific Deno versions.
  • Benefits:
    • Improved Accessibility: Users working with older Deno versions can reference appropriate documentation, reducing confusion and compatibility issues.
    • Enhanced Stability: Maintains accuracy and relevance of documentation across multiple Deno versions.
    • Facilitates Upgrades: Provides clear references for changes between versions, aiding developers in upgrading their projects.

Implementation Suggestions:

  • Version Selector: Add a dropdown menu to the documentation site for selecting different documentation versions.
  • URL Structure: Organize documentation URLs to include version identifiers, e.g., https://docs.deno.land/manual/v1.0/, https://docs.deno.land/manual/v2.0/.
  • Maintenance Strategy: Utilize branches or tags in the documentation repository to manage and update different documentation versions independently.

Conclusion:
Implementing versioned documentation will significantly enhance the user experience by catering to the diverse range of Deno versions in use, ensuring that developers have access to accurate and relevant information tailored to their specific needs.

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

1 participant