Move the Quick Start documentation into rustdoc

Open
#806 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Locate the existing Quick Start documentation and inspect how the ndarray rustdoc is published through docs.rs. Confirm which Quick Start content should move, then verify that the intended material is available in the generated ndarray documentation.

Written by the indexing model from the issue text.

Description

Just like the for numpy users documentation, IMO docs.rs/ndarray is the go to place for documentation, so anything we want to reach as many as possible should be there.

Dominant language
Rust
Stars
4.3k
Forks
391
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 rust-ndarray/ndarray

All issues in rust-ndarray/ndarray

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.