mlpack / mlpack/mlpack.org

Use cards on docs.md page

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

Nobody has claimed this yet.

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

Description

Right now the page http://www.mlpack.org/docs.html links to several different categories of documentation. This could be cleaned up into cards, more like the homepage, that make navigation to the desired documentation a little bit easier.

See this discussion for more information: https://github.com/mlpack/mlpack.org/pull/9#discussion_r349893958

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.

Research direction

Start by reading the discussion linked from the issue, then inspect docs.md and the homepage’s existing card layout. Update the documentation page so its categories use cards and navigation to each documentation section is easier; done means the categories are presented consistently and all links still work.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.