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

[Docs]: Documentation Refactoring for /commands page #163

Open
Abhishek-Mallick opened this issue Oct 20, 2024 · 0 comments
Open

[Docs]: Documentation Refactoring for /commands page #163

Abhishek-Mallick opened this issue Oct 20, 2024 · 0 comments
Labels
docs Issues related to the docs website documentation Improvements or additions to documentation hacktoberfest marks issues which are accepted under hacktoberfest no-code Issues related to no-code/docs contributions

Comments

@Abhishek-Mallick
Copy link
Owner

Is your issue related to a specific problem? Please describe.
This issue aims to create a dedicated /commands page within the documentation of the Universal-Box project. This page will serve as a comprehensive guide to all commands available in Universal-Box, allowing users to easily understand their functionalities and usage. The information will be sourced from the existing command descriptions found at Universal-Box Usage and supplemented with videos demonstrating each command.

Tasks

  1. Create the Commands Documentation File

    • Create the markdown file at website/content/Commands/0.index.md.
    • Reference: Use the command descriptions available at Universal-Box Usage as a guide.
    • Include sections for each command, detailing what it does and how to use it effectively.
  2. Incorporate Video Demonstrations

    • For each command, include links to relevant video demonstrations that showcase how to use the command in practice.
    • Ensure that the videos are embedded or linked clearly so users can easily access them.
  3. Add Command Descriptions

    • Write concise descriptions for each command, summarizing its purpose and functionality.
    • For example:
      • init: Initializes a new project using one of the starter templates.
      • get: Clones a GitHub repository or a specific subdirectory from it.
      • lint: Adds default linting configurations for your project.
      • deploy: Triggers the build and deployment pipeline (currently under development).
      • generate: Generates project files based on a provided configuration file.
  4. Review and Edit for Clarity

    • Ensure that all descriptions are clear and easy to understand.
    • Fix any grammatical issues or typos throughout the documentation.

How to run the docs website locally

Pretty easy ✌️

  1. Fork this repository
  2. Clone the forked repository
https://github.com/<username>/universal-box.git
cd universal-box

Run the docs website locally

cd website
npm install
npm run dev

Docs website should be live at http://localhost:3000/

Additional Information

If you would like to pick this up but feel that some tasks require further subdivision or clarification, please let me know! We can break down specific tasks into smaller issues if needed.
Join Discord for more real-time communication.

@Abhishek-Mallick Abhishek-Mallick added documentation Improvements or additions to documentation hacktoberfest marks issues which are accepted under hacktoberfest docs Issues related to the docs website no-code Issues related to no-code/docs contributions labels Oct 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues related to the docs website documentation Improvements or additions to documentation hacktoberfest marks issues which are accepted under hacktoberfest no-code Issues related to no-code/docs contributions
Projects
None yet
Development

No branches or pull requests

1 participant