Skip to content

documentation improvement #384

@Niyatizzz

Description

@Niyatizzz

hi, the current documentation is out-dated and can be modified further, incorporating latest installation guides and removing dead links, here are a few suggested improvements for the Volcano website repository's README.md file. The goal is to make the documentation more professional, developer-friendly, technically accurate, and easier to follow for both newcomers and experienced contributors.

Numbering in Quickstart

  • CURRENT: All steps use 1. (valid markdown, but harder to scan)
  • SUGGESTION: Replace with actual numbered steps for clarity.

Dead link: "See the GitHub workflow"

Homebrew installs latest Hugo (may be incompatible)

  • CURRENT: "brew install hugo"
  • SUGGESTION: update to latest installation commands

Missing Windows instructions for Hugo

  • SUGGESTION: Add section for Windows users

Missing repo clone command in Local Preview section

  • SUGGESTION: Add before running hugo server

i would like to work on documentation issues incluing the ones mentioned above, thereby enhancing the documentation of the repo

/assign

Metadata

Metadata

Assignees

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