Skip to content

Conversation

@yuanyl630
Copy link
Contributor

Description

This PR renames all documentation files from numeric names to meaningful, descriptive names to improve code maintainability and readability.

Changes

  • Renamed 77 Chinese documentation files (CN/modules/ROOT/pages/master/)
  • Renamed 72 English documentation files (EN/modules/ROOT/pages/master/)
  • Updated navigation files (nav.adoc) to reflect the new file names
  • No content changes, only file renaming

Examples of Renaming

  • 1.adocrelease_notes.adoc
  • 2.adocabout_ivorysql.adoc
  • 3.1.adocquick_start.adoc
  • 4.1.adocinstallation_guide.adoc
  • 5.1.adocpostgis.adoc
  • 7.1.adocframework_design.adoc
  • 8.1.adoc/8.adoccommunity_contribution_guide.adoc
  • And many more...

Benefits

  • Improved Discoverability: File names now clearly indicate their content
  • Better Maintainability: Easier to locate and update specific documentation
  • Enhanced Developer Experience: No need to memorize or look up numeric file mappings
  • Self-Documenting: File structure now serves as documentation itself

Testing

  • Verified that all file references in nav.adoc are updated correctly
  • Confirmed that no content was modified during the renaming process

@github-actions github-actions bot temporarily deployed to pull request January 30, 2026 09:45 Inactive
@github-actions
Copy link

🚀 IvorySQL-Docs Preview Ready

@OreoYang
Copy link
Contributor

This is a meaningful improvement. I've had it on my radar but hadn't gotten to it yet.

@github-actions github-actions bot temporarily deployed to pull request February 3, 2026 06:44 Inactive
@github-actions
Copy link

github-actions bot commented Feb 3, 2026

🚀 IvorySQL-Docs Preview Ready

@github-actions
Copy link

github-actions bot commented Feb 3, 2026

🚀 IvorySQL-Docs Preview Ready

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 this pull request may close these issues.

3 participants