theupdateframework / theupdateframework/community

Remove stray docs how to

Open
#31 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
9
Forks
8
Avg merge
53m
Merged PRs (30d)
1

Description

how_to_contribute_to_docs.md gives general instructions on how to start a hugo server and how to add a menu on a hugo website.

The community repo is not the right place (the website repo, which uses hugo, would be a better fit), nor do the instructions provide much value, e.g. compared to linking to the hugo reference docs.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review how_to_contribute_to_docs.md and compare its content with the linked website repository, which uses Hugo. Done means removing the misplaced file from this community repository rather than maintaining these instructions here.

Written by the indexing model from the issue text.

Assessment

Tech stack
hugo
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.