Skip to content

Rename documentation tree to documents/ and update tooling, CI and test paths - #61

Merged
shun126 merged 1 commit into
masterfrom
codex-pgevgb
Sep 24, 2026
Merged

shun126 merged 1 commit into
masterfrom
codex-pgevgb

Conversation

@shun126

@shun126 shun126 commented Sep 24, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Unify and correct the documentation directory name from document/ to documents/ and update all tooling that references it so generated site/wiki assets and links resolve correctly.
  • Ensure CI workflows, doc build/export scripts and asset handling point at the new paths and keep generated outputs out of the repository.
  • Keep developer tooling and test locations consistent by renaming test/ -> tests/ where used by build scripts and solution files.

Description

  • Renamed the documentation source tree from document/ to documents/ and moved all files and assets accordingly (many document/... -> documents/...).
  • Updated documentation tooling to use the new path: adjusted documents/tools/* scripts (build-pages.py, check-docs.py, export-wiki.py, manadoc.py, verify-examples.py) and their requirements.txt and tests to reference documents and documents/* assets and configurations (for example document_root defaults and asset prefixes).
  • Updated CI/workflow files in .github/workflows/ to match the new paths: publish-pages.yml, publish-wiki.yml and build_and_analysis.yml now reference documents/... and updated Windows/Linux build/test invocation paths where needed.
  • Adjusted repository files and tooling configs: README.md, examples/* docs, .gitignore (exclude tests/ and documents/ output), driver/Makefile (references to tests/), Visual Studio solution mana.sln and many test -> tests renames for C++ and mana test suites.

Testing

  • No automated tests were executed as part of this change; the PR updates CI/workflow and test paths so that repository CI should exercise the adjusted pipelines.
  • The change is limited to path and configuration updates (file renames and internal references) and requires running the documentation tool unit tests and CI to validate end-to-end behavior: run python -m unittest discover -s documents/tools and the existing CI workflows to confirm.

Codex Task

@shun126 shun126 self-assigned this Sep 24, 2026
@shun126 shun126 added this to the 1.0 milestone Sep 24, 2026
@shun126
shun126 merged commit 842c952 into master Sep 24, 2026
11 checks passed
@shun126
shun126 deleted the codex-pgevgb branch September 24, 2026 01:05
@github-project-automation github-project-automation Bot moved this from Todo to Done in Mana Script Sep 24, 2026
shun126 added a commit that referenced this pull request Sep 26, 2026
Rename documentation tree to `documents/` and update tooling, CI and test paths
shun126 added a commit that referenced this pull request Sep 26, 2026
Rename documentation tree to `documents/` and update tooling, CI and test paths
shun126 added a commit that referenced this pull request Sep 26, 2026
Rename documentation tree to `documents/` and update tooling, CI and test paths
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant