mdolab / mdolab/openconcept

Broken N2 diagrams in docs

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

Nobody has claimed this yet.

Dominant language
Python
Stars
62
Forks
43
PR merge metrics
No merged PRs in 30d

Description

Description

The N2 diagrams in the OpenConcept documentation are broken. For example, the one in the minimal example tutorial looks like this:
image

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 with the N2 diagram in the minimal example tutorial and inspect how that documentation image is generated or referenced. Identify the cause of the broken rendering and update the documentation so the diagram displays correctly; done means the affected N2 diagrams render normally.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.