Add documentation to build the website/docs locally

Open
#50 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by inspecting the repository's existing documentation and the website/docs build entry points to determine the local prerequisites and commands. Document how to build the docs and website locally, and consider the work done when a newcomer can follow the instructions successfully from a clean checkout.

Written by the indexing model from the issue text.

Description

Recently there was a conversation on IRC asking about how to build the docs as well as the website locally.

I think it is a good idea to have the instructions present on this repository itself. I'll work on it if I have some free time this week, otherwise, feel free to work on it. :)

Dominant language
C
Stars
13
Forks
18
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

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.

More from mlpack/mlpack.org

All issues in mlpack/mlpack.org

Similar issues

More C issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.