llnl / llnl/smith

Improve flow of Dev Guide Profiling Page

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

Nobody has claimed this yet.

documentation enhancement
Dominant language
C++
Stars
245
Forks
36
Avg merge
8d 23h
Merged PRs (30d)
4

Description

This page could be improved by breaking it down into sections.

https://serac.readthedocs.io/en/latest/sphinx/dev_guide/profiling.html

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

Start by reading the Dev Guide Profiling Page at https://serac.readthedocs.io/en/latest/sphinx/dev_guide/profiling.html and locate its source in the documentation. Identify logical sections that improve the page flow, then verify the rendered page is clearly divided into those sections.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.