Skip to content

Auto synchronize the test problems README.md to wiki page#350

Open
ChunYen-Chen wants to merge 7 commits intogamer-project:mainfrom
ChunYen-Chen:test_read
Open

Auto synchronize the test problems README.md to wiki page#350
ChunYen-Chen wants to merge 7 commits intogamer-project:mainfrom
ChunYen-Chen:test_read

Conversation

@ChunYen-Chen
Copy link
Copy Markdown
Collaborator

@ChunYen-Chen ChunYen-Chen commented Sep 8, 2024

Similar to PR #337, this PR includes the auto-update wiki workflow Update test problem wiki page.

Setup

Please ensure that the secret MY_EMAIL and TOKEN_FOR_WIKI are set in your repository.

How it works

This workflow is triggered by any changes to the following files:

  • example/test_problem/*/*/README.md
  • tool/wiki/sync_test_problem_pages.py

Others

All the README of test problems are updated to the markdown style.

@ChunYen-Chen ChunYen-Chen marked this pull request as draft December 12, 2024 05:44
@ChunYen-Chen ChunYen-Chen marked this pull request as ready for review December 17, 2024 05:51
@hyschive
Copy link
Copy Markdown
Contributor

@ChunYen-Chen Please resolve the conflicts.

Comment thread doc/wiki/Test-Problem-related/Test-Problems:-DiskHeating.md Outdated
Comment thread doc/wiki/Test-Problem-related/Test-Problems:-DiskHeating.md Outdated
Comment thread doc/wiki/Test-Problem-related/Test-Problems:-DiskHeating.md Outdated
Comment thread doc/wiki/Test-Problem-related/Test-Problems:-DiskHeating.md Outdated
Comment thread example/test_problem/ELBDM/GaussianWavePacket/README.md Outdated
Comment thread example/test_problem/ELBDM/LSS/README.md Outdated
Comment thread example/test_problem/ELBDM/LSS_Hybrid/README.md Outdated
Comment thread example/test_problem/ELBDM/LSS_Hybrid/README.md Outdated
Comment thread tool/wiki/sync_test_problem_pages.py Outdated
Comment thread tool/wiki/sync_test_problem_pages.py Outdated
@hsinhaoHHuang
Copy link
Copy Markdown
Contributor

hsinhaoHHuang commented Jan 24, 2025

  • Add a backlink at the footnote of each test problem.
  • Use a unified style of list.

Copy link
Copy Markdown
Contributor

@hsinhaoHHuang hsinhaoHHuang left a comment

Choose a reason for hiding this comment

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

@ChunYen-Chen
Thanks for this PR. This is quite a huge task!
I have reviewed through all of the test problems. Beside the inline comments, there are two general comments:

  1. About the format of tables.
    Although it will not affect the rendering of markdown on GitHub, I think it would look better in plain text mode if we could align the table borders and fill in the dashed lines in the grid for the headers.
    For example, in example/test_problem/ELBDM/IsolatedHalo/README.md

    - Boundary conditions
      | Parameter name | Value | Note |
      |---             |---    |--- |
      | OPT__BC_FLU_*  | 1     | periodic |
      | OPT__BC_POT    | 2     | isolated |
    

    ->

    - Boundary conditions
      | Parameter name | Value | Note     |
      |----------------|-------|----------|
      | OPT__BC_FLU_*  | 1     | periodic |
      | OPT__BC_POT    | 2     | isolated |
    
  2. About the version control.
    It seems that for most ELBDM test problems (e.g., DiskHeating, GaussianWavePacket, IsolatedHalo, LSS_Hybrid) (except for HaloMerger), the git history is lost after file renaming. (HYDRO test problems don't have this issue).
    I guess it is because both the filename and contents changed a lot in the same commit and git lost track of them.
    I guess we need to separate the file renaming and modifying contents into two commits to avoid this issue (like you did for HYDRO).

    • On local, with git log --follow, there's no previous commits.
      $ git log --follow --oneline example/test_problem/ELBDM/DiskHeating/README.md
      f5cd21d Update wiki
      c42c98f Update wiki
      d005b60 Update wiki
      dce7730 Typo
      4a4a138 Rename the title
      9dcde1d Update README.md
      7108133 Update README.md
      12e84db Add ELBDM test problems
    • On GitHub commits, it shows the wrong history.
      截圖 2025-01-28 下午11 18 31

Comment thread example/test_problem/ELBDM/DiskHeating/README.md Outdated
Comment thread example/test_problem/ELBDM/DiskHeating/README.md Outdated
Comment thread example/test_problem/ELBDM/HaloMerger/README.md Outdated
Comment thread example/test_problem/ELBDM/HaloMerger/README.md Outdated
Comment on lines +36 to +37
> [!CAUTION]
> This setup requires further verification
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I am not sure, but I guess this refers to the above STABLE setup. If so, it would be better to align it with the same indentation.

Suggested change
> [!CAUTION]
> This setup requires further verification
> [!CAUTION]
> This setup requires further verification

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Comment thread example/test_problem/Hydro/Plummer/README.md Outdated
Comment thread example/test_problem/Hydro/Plummer/README.md Outdated
Comment thread example/test_problem/Hydro/Riemann/README.md Outdated
Comment thread example/test_problem/Hydro/Riemann/README.md
Comment thread example/test_problem/Hydro/Zeldovich/README.md Outdated
Conflicts:
	example/test_problem/ELBDM/DiskHeating/README
	example/test_problem/ELBDM/GaussianWavePacket/README
	example/test_problem/ELBDM/HaloMerger/README
	example/test_problem/ELBDM/IsolatedHalo/README
	example/test_problem/ELBDM/PlaneWave/README
	example/test_problem/Hydro/Zeldovich/README
@hyschive
Copy link
Copy Markdown
Contributor

@ChunYen-Chen @hsinhaoHHuang Please let me know when this PR is ready to be merged. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation enhancement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants