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

Initial clean-up and reorganization of PowerFlows documentation #51

Open
4 tasks
kennedy-mindermann opened this issue Oct 17, 2024 · 2 comments
Open
4 tasks
Labels
documentation Improvements or additions to documentation

Comments

@kennedy-mindermann
Copy link

The existing PowerFlows documentation needs to be cleaned up prior to reorganizing with the new Diataxis format. This includes:

  • Upgrading to Documenter > 1.0 and resolving errors to enforce strict compilation
  • Adding .md formatting to the formatter script
  • Proof-reading for formatting and misformatted code references
  • Adding hyperlinks everywhere
@rodrigomha
Copy link
Collaborator

I will add here that we need to properly do the Docs. We don't really have documented all the capabilities in our existing docs.

@GabrielKS
Copy link
Contributor

I will add here that we need to properly do the Docs. We don't really have documented all the capabilities in our existing docs.

And probably even before that we need to properly solidify the interface, see #38.

@kennedy-mindermann kennedy-mindermann added the documentation Improvements or additions to documentation label Nov 6, 2024
@kennedy-mindermann kennedy-mindermann changed the title Initial clean-up of PowerFlows documentation Initial clean-up and reorganization of PowerFlows documentation Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants