[Docs]: Documentation Refactoring for /commands
page
#163
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
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
Create the Commands Documentation File
website/content/Commands/0.index.md
.Incorporate Video Demonstrations
Add Command Descriptions
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.Review and Edit for Clarity
How to run the docs website locally
Pretty easy ✌️
Run the docs website locally
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.
The text was updated successfully, but these errors were encountered: