Skip to content

[Enhancement] Add Devcontainer for Documentation Development #123

@jayesh9747

Description

@jayesh9747

[Enhancement] Add Devcontainer for Documentation Development

Desired behavior

Currently, contributors need to manually set up the website documentation development environment on their local system. This setup process can be complex and time-consuming due to dependency management and platform-specific issues.

By providing a Devcontainer, contributors can quickly start developing in a pre-configured, standardized environment without worrying about system-specific configurations. This ensures:

  • A consistent development experience across all contributors.
  • No dependency conflicts or local setup issues.
  • Easy integration with VS Code Remote Containers and GitHub Codespaces.

Current behavior

  • Developers must manually install dependencies and configure their local environment.
  • Potential issues arise due to differences in OS, dependencies, and package versions.
  • Contributors may face challenges in getting started, leading to a higher onboarding time.

Value add

  • Simplifies onboarding for new contributors by removing manual setup steps.
  • Prevents dependency conflicts and ensures uniformity across development environments.
  • Enhances productivity by allowing developers to start contributing immediately.

Add labels

  • enhancement
  • documentation
  • developer-experience

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions