Skip to content

docs: sync some changes from hpcflow-shared-docs #856

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

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

aplowman
Copy link
Contributor

No description provided.

@aplowman aplowman added the documentation Improvements or additions to documentation label Jul 16, 2025
@aplowman aplowman requested a review from a team as a code owner July 16, 2025 09:17
@aplowman aplowman marked this pull request as draft July 16, 2025 09:18
Copy link
Collaborator

@gcapes gcapes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has got a bit confusing, and I wouldn't merge it as-is.

There shouldn't be duplication of the examples, or at the least, the code should exist in one place only, in a code file.

I can't find where this file is used or referenced: docs/source/user/tutorials/tutorial_resources/generate_input_file.py but the code is reproduced in docs/source/user/getting_started/custom_task_schemas_and_workflows.rst . There are a few examples of this. In fact, I can't see any reference to anything under tutorial_resources -- though the content of a good number of those files are used in the user/getting_started section.

I have moved all the runnable examples into separate code files in hpcflow/hpcflow-shared-docs#12. Perhaps we can merge that, then look at what's going on with the unused/duplicated files?

I guess it's only possible to build the documentation from the shared repo by first syncing it into hpcflow/matflow first?


{{ app_module }} go <workflow_name.yaml>

This small workflow should complete in less than 30s.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure which demo workflow we're supposed to be running?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the matflow docs, I suggested using modify_volume_element_grid_size

@aplowman
Copy link
Contributor Author

Could I assign resolving this to you @gcapes? This should really be a trivial PR. Obviously, we have a problem with the content in the shared repo.

I guess it's only possible to build the documentation from the shared repo by first syncing it into hpcflow/matflow first?

Yep.

@gcapes
Copy link
Collaborator

gcapes commented Jul 16, 2025

Sure - how about I add it to my PR in the shared docs repo?

@aplowman aplowman assigned aplowman and gcapes and unassigned aplowman Jul 16, 2025
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

Successfully merging this pull request may close these issues.

2 participants