tracel-ai/burn

Add `source` button in Docs

Open

#1,244 opened on Feb 3, 2024

View on GitHub
 (8 comments) (1 reaction) (0 assignees)Rust (964 forks)auto 404
good first issueinfrastructure

Repository metrics

Stars
 (15,550 stars)
PR merge metrics
 (PR metrics pending)

Description

The source button present in docs for tch-rs as a sample - image

No such button for burn-rs docs image

It would greatly help looking into pin-pointing the definition and implementation of modules in this vast repo

Contributor guide

Research direction
Investigate how the documentation site is built (e.g., using mdbook, rustdoc, or Docusaurus) and locate the template or configuration where the source button can be added. Look for similar implementations in other crates like tch rs for reference.
Tech stack
rust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBasic knowledge of documentation generation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90