Skip to content

docs: add 'Contributing to Documentation' guide (#529)#537

Open
Aayushmaan-24 wants to merge 1 commit into
unikraft:mainfrom
Aayushmaan-24:add-contributing-to-docs-guide-529
Open

docs: add 'Contributing to Documentation' guide (#529)#537
Aayushmaan-24 wants to merge 1 commit into
unikraft:mainfrom
Aayushmaan-24:add-contributing-to-docs-guide-529

Conversation

@Aayushmaan-24
Copy link
Copy Markdown

Adds a new guide to help contributors improve Unikraft documentation (#529).

Covers:

  • Local setup (Hugo extended, Node, modules)
  • MDX editing style (one sentence per line, code fences, console split)
  • Previewing with hugo server
  • Linting (markdownlint, super-linter)
  • Common fixes (links, headings, spacing)
  • PR process + DCO sign-off
  • Tips and where to ask for help

Formatted to match project style and lint rules.

Happy to iterate on tone, add sections, or fix anything.

Closes #529

New guide covering setup, MDX editing, linting, preview, PR process, DCO, and tips for contributing to Unikraft docs.

Addresses unikraft#529 by providing dedicated documentation contribution instructions.

Previewed formatting locally and ensured lint compliance.

Signed-off-by: Aayushmaan <aayushmaan.chakraborty@gmail.com>
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

Successfully merging this pull request may close these issues.

Port old contributing to Unikraft guide

1 participant