llnl / llnl/conduit

Consider splitting Blueprint protocol documentation into separate pages

Open
#1,601 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
248
Forks
72
Avg merge
1d 16h
Merged PRs (30d)
15

Description

The Blueprint protocol documentation that describes how to make Blueprint objects is getting quite long.

I'd like to be able to jump to various topics using the index links on the left of the page but most of interesting topics are not listed in the index because the index is not deep enough. For example, I'd like to be able to jump to "unstructured topologies" or "Multi-Buffer Element-Dominant Material Sets".

* It might be time to split the page into different sub-pages for "coordsets", "topologies", etc and use links to reference among them. I think by splitting, it would make the sub-sections that are currently not in the index move up a level so we can jump right to specific topics.
* Or, allow 1 more level in the index

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 locating the Blueprint protocol documentation and reviewing its current left-hand index. Compare splitting the coordsets and topologies sections into sub-pages with allowing one more index level, including topics such as unstructured topologies and Multi-Buffer Element-Dominant Material Sets. Done means the chosen structure makes these topics directly reachable and preserves links among the related documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.