Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Request]: Move, reorganize Scheduled maintenance docs #745

Closed
cfe316 opened this issue Aug 19, 2024 · 0 comments
Closed

[Request]: Move, reorganize Scheduled maintenance docs #745

cfe316 opened this issue Aug 19, 2024 · 0 comments
Milestone

Comments

@cfe316
Copy link
Collaborator

cfe316 commented Aug 19, 2024

Feature description

Presently there are two copies of the maintenance documentation.
docs/src/Model_Reference/maintenance_overview.md
Maintenance

and
docs/src/Model_Reference/Resources/maintenance.md
Scheduled maintenance for various resources

The two are slightly different at the end, with one having some function references and one giving some advice on how to add maintenance to a resource.

Motivation

Docs will be cleaner & make more sense.

Implementation strategy

The docs should be deduplicated. One page should be placed in Resources/Thermal, since it's not for various resources.

If desired the more technical bits could be placed in the developer docs section.

Additional context

I plan on also putting Fusion docs in the Resources / Thermal folder.

@cfe316 cfe316 closed this as completed Aug 29, 2024
@GenXProject GenXProject added this to the v0.4.2 milestone Jan 16, 2025
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

No branches or pull requests

2 participants