godarrenw opened a new pull request, #18542:
URL: https://github.com/apache/iotdb/pull/18542

   ## Description
   
   The "Contributing documents" section of `CONTRIBUTING.md` describes a 
`docs/` directory that no longer exists in this repository, so a new 
contributor who wants to fix a documentation page has nowhere to go.
   
   `git ls-tree -r --name-only HEAD | grep '^docs/'` returns nothing — the 
website content now lives in 
[apache/iotdb-docs](https://github.com/apache/iotdb-docs) (last pushed 
2026-08-24), under its `src` directory.
   
   Almost every line of that section is now inaccurate, so this PR updates it:
   
   **Location.** `docs/...` → `apache/iotdb-docs`, `src/...`.
   
   **Directory list.** I checked each path against `apache/iotdb-docs` rather 
than assuming the layout carried over:
   
   | documented path | new path | exists? |
   | --- | --- | --- |
   | `docs/UserGuide` | `src/UserGuide` | yes |
   | `docs/zh/UserGuide` | `src/zh/UserGuide` | yes |
   | `docs/Community` | `src/Community` | yes |
   | `docs/zh/Community` | `src/zh/Community` | yes |
   | `docs/Development` | `src/Development` | yes |
   | `docs/zh/Development` | — | **no** |
   | `docs/SystemDesign` | — | **no** |
   | `docs/zh/SystemDesign` | — | **no** |
   
   The three that no longer exist are dropped from the list.
   
   **Version mapping.** The section said versions map to branches (`In progress 
-> master`, `major_version.x -> rel/major_version`). `apache/iotdb-docs` has no 
`rel/*` branches — its only non-dependabot branches are `main` and `TableAuth` 
— and versions are directories instead: `src/UserGuide/` contains `Master`, 
`latest`, `latest-Table`, `V1.3.x`, `V1.2.x`, `V0.13.x`, `dev-1.3`. The text 
now says that.
   
   The "Precautions" bullets below (image hosting in `iotdb-bin-resources`, 
Unicode and dollar-sign rules) still apply and are untouched.
   
   ## How I checked
   
   Every path in the new list was resolved through the GitHub contents API 
against `apache/iotdb-docs`, and the branch list was read from the branches 
API. The absence of `docs/` here was confirmed with `git ls-tree` on the 
current `master` (`6aec4b8`) rather than by looking at a working copy.
   
   I searched the issue tracker and open PRs first and did not find an existing 
report or anyone working on this, so there is no issue to reference. If one 
exists that I missed, I'm happy to link it.
   
   _Disclosure: prepared with AI assistance; every path and branch above was 
verified against the live repositories._
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to