Skip to content

Rename wiki files#476

Merged
hyschive merged 29 commits intogamer-project:mainfrom
xuanweishan:rename_wiki_files
Feb 13, 2026
Merged

Rename wiki files#476
hyschive merged 29 commits intogamer-project:mainfrom
xuanweishan:rename_wiki_files

Conversation

@xuanweishan
Copy link
Contributor

Description

This PR solved the issue #325.
To support different OS file system, we rename the file names with : and *.

Changes

  • File names: Replace : with [ ], and replace * with {} in file names.
    • doc/wiki/Installation-related/Installation:*
      => doc/wiki/Installation-related/[Installation]*
    • doc/wiki/In-Situ-Python-Analysis-related/In-Situ-Python-Analysis:*
      => doc/wiki/In-Situ-Python-Analysis-related/[In-Situ-Python-Analysis]*
    • doc/wiki/Contribute-related/Contribute:*
      => doc/wiki/Contribute-related/[Contribute]*
    • doc/wiki/Performance-Optimizations-related/Performance-Optimizations:*
      => doc/wiki/Performance-Optimizations-related/[Performance-Optimizations]*
    • doc/wiki/Quick-Start-related/Quick-Start:*
      => doc/wiki/Quick-Start-related/[Quick-Start]*
    • doc/wiki/Runtime-Parameters-related/Runtime-Parameters:*
      => doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]*
      • doc/wiki/Runtime-Parameters:-Input__Flag_*.md
        => doc/wiki/[Runtime-Parameters]-Input__Flag_{}.md
    • doc/wiki/Simulation-Logs-related/Simulation-Logs:*
      => doc/wiki/Simulation-Logs-related/[Simulation-Logs]*
      • doc/wiki/Simulation-Logs:-Record__TimingMPI_Rank*.md
        => doc/wiki/[Simulation-Logs]-Record__TimingMPI_Rank{}.md
  • Modify the links related to name changed file.

@ChunYen-Chen
Copy link
Collaborator

@xuanweishan Before reviewing the PR, I noticed that the filenames in the workflow file (.github/workflows/update_all_parameter_page.yml) and the wiki tool (tool/wiki/sync_runtime_parameter.py) have not been updated. Once those are updated, I will begin the review.

@xuanweishan
Copy link
Contributor Author

Those two files are updated.

@ChunYen-Chen ChunYen-Chen linked an issue Jun 27, 2025 that may be closed by this pull request
@ChunYen-Chen
Copy link
Collaborator

ChunYen-Chen commented Jun 27, 2025

@xuanweishan please also fix the following links. Also, how about renaming the files under ELBDM-related to [ELBDM]-* to unify the naming style?

./doc/wiki/Adding-New-Simulations.md:235:for example, [[ GRACKLE_METAL | Runtime-Parameters:-Chemistry-and-Radiation#GRACKLE_METAL ]]).
./doc/wiki/Adding-New-Simulations.md:386:[[OPT__OUTPUT_USER | Runtime-Parameters:-Outputs#OPT__OUTPUT_USER]].
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__MemoryPool.md:2:[[OPT__MEMORY_POOL | Runtime-Parameters:-Refinement#OPT__MEMORY_POOL]].
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__MemoryPool.md:26:[[MAX_LEVEL | Runtime-Parameters:-Refinement#MAX_LEVEL]]+1
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__MemoryPool.md:28:[[MAX_LEVEL | Runtime-Parameters:-Refinement#MAX_LEVEL]]+1
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:8:* [[All | Runtime-Parameters:-All]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:11:* [[General | Runtime-Parameters:-General]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:14:* [[MPI and OpenMP | Runtime-Parameters:-MPI-and-OpenMP]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:17:* [[GPU | Runtime-Parameters:-GPU]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:20:* [[Units | Runtime-Parameters:-Units]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:23:* [[Initial Conditions | Runtime-Parameters:-Initial-Conditions]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:26:* [[Hydro | Runtime-Parameters:-Hydro]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:29:* [[Gravity | Runtime-Parameters:-Gravity]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:32:* [[Particles | Runtime-Parameters:-Particles]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:35:* [[Cosmology | Runtime-Parameters:-Cosmology]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:38:* [[Chemistry and Radiation | Runtime-Parameters:-Chemistry-and-Radiation]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:41:* [[Star Formation | Runtime-Parameters:-Star-Formation]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:44:* [[Feedback | Runtime-Parameters:-Feedback]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:47:* [[Timestep | Runtime-Parameters:-Timestep]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:50:* [[Refinement | Runtime-Parameters:-Refinement]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:53:* [[Interpolation | Runtime-Parameters:-Interpolation]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:56:* [[Outputs | Runtime-Parameters:-Outputs]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:59:* [[Miscellaneous | Runtime-Parameters:-Miscellaneous]]
./doc/wiki/Runtime-Parameters-related/[Runtime-Parameters]-Input__Parameter.md:100:system (set by [[OPT__UNIT | Runtime-Parameters:-Units#OPT__UNIT]]) unless otherwise specified.

@xuanweishan
Copy link
Contributor Author

@ChunYen-Chen I've rename files in doc/wiki/ELBDM-related and update the related links.
I also update file names and links in script and wiki pages.

Copy link
Collaborator

@ChunYen-Chen ChunYen-Chen left a comment

Choose a reason for hiding this comment

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

@xuanweishan Thanks for the contribution. I have left some comments. Please update the lines with comment tags [Bug] or [Style].

[Bug]: Some of the [[[xxx] yyy | page-link]] does not render the correct hypre link "[xxx] yyy" (currently "[xxx] yyy" ). By changing the text to [[ [xxx] yyy | page-link ]], the link can be shown correctly.

Our current wiki pages have an issue. [Runtime-Parameters]—All.md takes too long to render, so the page does not show on GitHub. (@hyschive)

@xuanweishan
Copy link
Contributor Author

@ChunYen-Chen Thanks for the suggestions, I've apply suggestions above.

Copy link
Collaborator

@ChunYen-Chen ChunYen-Chen left a comment

Choose a reason for hiding this comment

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

@xuanweishan Thanks for the update. I have left some final comments.

@xuanweishan
Copy link
Contributor Author

The suggestions above are applied. Please check.

@xuanweishan
Copy link
Contributor Author

@ChunYen-Chen The bug is fixed. Thanks for the carefully checking.

Copy link
Collaborator

@ChunYen-Chen ChunYen-Chen left a comment

Choose a reason for hiding this comment

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

@xuanweishan Thanks for the update.
@hyschive I think this PR is ready to go.

Copy link
Contributor

@hyschive hyschive left a comment

Choose a reason for hiding this comment

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

@xuanweishan @ChunYen-Chen Thanks for your contributions and the detailed review!

@hyschive hyschive merged commit 4c5e21b into gamer-project:main Feb 13, 2026
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.

Filename with colon

3 participants