Skip to content

Docs overhaul, part 1: Getting Started, partial User's Guide, and Examples#994

Open
jkirk5 wants to merge 81 commits intoOpenMDAO:mainfrom
jkirk5:docs
Open

Docs overhaul, part 1: Getting Started, partial User's Guide, and Examples#994
jkirk5 wants to merge 81 commits intoOpenMDAO:mainfrom
jkirk5:docs

Conversation

@jkirk5
Copy link
Contributor

@jkirk5 jkirk5 commented Feb 17, 2026

Summary

Overhauling the documentation from the ground up, starting with the first things users will see. Some pages are written from scratch, many are existing pages that were overhauled. Doc pages that haven't been refreshed yet were moved into separate folders (temporary until they are reviewed). A deleted doc page doesn't mean that topic will be permanently removed from the docs - it usually means that docs page was far to outdated or required too significant an overhaul to pair with the new docs, and will need to be re-written from scratch.

  1. Getting Started section complete (pending TODOs to link to pages that don't exist yet)
  2. User's Guide partially reworked, with new organization
  3. All examples moved into docs. Old aviary/examples folder removed

The NPSS model was moved to the Aviary community repo. It is not able to be used by the vast majority of Aviary users, and as such doesn't make sense to include by default in the repository. It is also not able to be checked via CI, further motivating removing it from this repository.

A couple very minor code changes that were uncovered via inconsistencies found while rewriting the docs.

Related Issues

Backwards incompatibilities

None

New Dependencies

None

jkirk5 added a commit to jkirk5/om-Aviary that referenced this pull request Feb 26, 2026
@jkirk5 jkirk5 closed this Mar 25, 2026
@jkirk5
Copy link
Contributor Author

jkirk5 commented Mar 25, 2026

No idea why github auto-closed this!

@jkirk5 jkirk5 reopened this Mar 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Move all examples into docs Change doc examples to remove use of mixed (e.g. GwGm) bench tests Update Example Documentation

2 participants