Skip to content

Move relevant docs out of downstream repos #5

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

Open
SJaffa opened this issue May 8, 2025 · 1 comment · May be fixed by #9
Open

Move relevant docs out of downstream repos #5

SJaffa opened this issue May 8, 2025 · 1 comment · May be fixed by #9
Assignees

Comments

@SJaffa
Copy link
Collaborator

SJaffa commented May 8, 2025

Some new documentation has been written in https://github.com/hpcflow/matflow-new/tree/develop/docs but some of it is also relevant to HPCflow, so it should be moved to this upstream repo.

@SJaffa
Copy link
Collaborator Author

SJaffa commented May 8, 2025

Checking which esctions have diverged. Starting form docs/source:

  • _static - logo images are different, presumably the different names are handled somewhere?
  • _templates
  • contribute
  • reference
    • template components
      • task_schemas.rst - matflow added jinja reference
    • cli.rst
    • config_file.rst - matflow added jinja reference
    • glossary.rst - lots of differences, some of them justified
    • index.rst - differences and doesn't exist in this repo
    • template_components.rst
    • workflows.rst
  • user - lots of differences
    • getting_started - only in matflow
    • how_to
      • config.rst - many differences
      • environments.rst
      • index.rst - hpcflow has ref to resources
      • loops.rst
      • meta-tasks.rst
      • resources.rst - only in hpcflow
      • task_schemas.rst
      • template_components.rst
      • workflow_tempaltes.rst
      • workflows.rst
    • tutorials
      • index.rst - matflow has ref to jupyter notebooks
      • notebooks - only in matflow but hte notebook is material science specific, so that is ok
    • index - reference to getting_started
  • conf.py - matflow added supported python versions
  • installation.rst - lots of differences

I'll work through the simple ones now

@SJaffa SJaffa linked a pull request May 8, 2025 that will close this issue
@SJaffa SJaffa self-assigned this May 8, 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

Successfully merging a pull request may close this issue.

1 participant