move files under readme/ (#5035)

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>

Author: jsundai

.github/ISSUE_TEMPLATE/config.yml

@@ -1,6 +1,6 @@
 blank_issues_enabled: false
 contact_links:
-  - "https://github.com/temporalio/documentation/blob/main/CONTACT.md"
+  - "https://github.com/temporalio/documentation/blob/main/readme/CONTACT.md"
 templates:
   - name: "Typos and Grammar"
     description: "Report typos, spelling mistakes, or grammar problems."

.github/workflows/check-orphan-pages.yml

@@ -101,7 +101,7 @@ jobs:
 
             const report = fs.readFileSync('report.txt', 'utf8');
             const body = hasFindings
-              ? `${marker}\n### ⚠️ Orphan pages check\n\nThis is informational and does not block merging.\n\n\`\`\`\n${report}\n\`\`\`\n\nSee [UTILITIES.md](https://github.com/${context.repo.owner}/${context.repo.repo}/blob/main/UTILITIES.md#check-orphan-pages) for what to do next.`
+              ? `${marker}\n### ⚠️ Orphan pages check\n\nThis is informational and does not block merging.\n\n\`\`\`\n${report}\n\`\`\`\n\nSee [UTILITIES.md](https://github.com/${context.repo.owner}/${context.repo.repo}/blob/main/readme/UTILITIES.md#check-orphan-pages) for what to do next.`
               : `${marker}\n### ✅ Orphan pages check\n\nNo orphaned pages found.`;
 
             if (existing) {

AGENTS.md

@@ -7,12 +7,12 @@ repository.
 
 | Topic                        | File                                                         |
 | ---------------------------- | ------------------------------------------------------------ |
-| Where content belongs        | [INFORMATION-ARCHITECTURE.md](./INFORMATION-ARCHITECTURE.md) |
-| React components in MDX      | [COMPONENTS.md](./COMPONENTS.md)                             |
-| Mermaid diagrams             | [MERMAID.md](./readme/MERMAID.md)                            |
-| LLM Markdown pipeline        | [MARKDOWN_PIPELINE.md](./MARKDOWN_PIPELINE.md)               |
-| Component → Markdown mapping | [COMPONENT_REGISTRY.md](./COMPONENT_REGISTRY.md)             |
-| CI jobs and scheduled jobs   | [AUTOMATIONS.md](./AUTOMATIONS.md)                           |
+| Where content belongs        | [INFORMATION-ARCHITECTURE.md](./readme/INFORMATION-ARCHITECTURE.md) |
+| React components in MDX      | [COMPONENTS.md](./readme/COMPONENTS.md)                             |
+| Mermaid diagrams             | [MERMAID.md](./readme/MERMAID.md)                                   |
+| LLM Markdown pipeline        | [MARKDOWN_PIPELINE.md](./readme/MARKDOWN_PIPELINE.md)               |
+| Component → Markdown mapping | [COMPONENT_REGISTRY.md](./readme/COMPONENT_REGISTRY.md)             |
+| CI jobs and scheduled jobs   | [AUTOMATIONS.md](./AUTOMATIONS.md)                                  |
 
 ## Repository overview
 
@@ -23,11 +23,11 @@ repository.
 
 ## Where to put content
 
-Use [INFORMATION-ARCHITECTURE.md](./INFORMATION-ARCHITECTURE.md) to choose the section.
+Use [INFORMATION-ARCHITECTURE.md](./readme/INFORMATION-ARCHITECTURE.md) to choose the section.
 
 ## Style Guide
 
-Follow [STYLE.md](./STYLE.md) and Vale rules in `vale/styles/`. The most common mistakes:
+Follow [STYLE.md](./readme/STYLE.md) and Vale rules in `vale/styles/`. The most common mistakes:
 
 ### Temporal terms are proper nouns
 
@@ -64,7 +64,7 @@ In code blocks, follow each language's conventions.
 
 ### Writing style
 
-Follow [STYLE.md](./STYLE.md) and the [Google developer documentation style guide](https://developers.google.com/style)
+Follow [STYLE.md](./readme/STYLE.md) and the [Google developer documentation style guide](https://developers.google.com/style)
 for tone (conversational, second person, active voice) and structure (short paragraphs, one idea per sentence). A few
 additions specific to model output:
 
@@ -121,8 +121,8 @@ tags:
 - Pages are `.mdx` with YAML frontmatter (see [Frontmatter](#frontmatter) above).
 - Import shared components from `@site/src/components` unless a page uses a one-off import path already established
   nearby.
-- Before adding a component, check [COMPONENTS.md](./COMPONENTS.md) and
-  [COMPONENT_REGISTRY.md](./COMPONENT_REGISTRY.md).
+- Before adding a component, check [COMPONENTS.md](./readme/COMPONENTS.md) and
+  [COMPONENT_REGISTRY.md](./readme/COMPONENT_REGISTRY.md).
 - Reuse existing components (`Tabs`, `SdkTabs`, `CaptionedImage`, `ViewSourceCodeNotice`, etc.) instead of inventing
   inline HTML patterns.
 - Interactive demos live in `src/components/elements/`. Export new public components from `src/components/index.js` when
@@ -168,8 +168,8 @@ record it in `bin/metrics-baseline.json` rather than suppressing the check.
 `yarn check:orphans` reports pages that will build and get a real URL but aren't reachable from `sidebars.js`. A page
 that should stay linkable without navigation belongs in frontmatter as `unlisted: true`, not `draft: true` (draft pages
 don't build in production at all, which 404s any inbound links). A page that's a known, accepted exception for now
-belongs in `bin/orphan-pages-baseline.json` with a note, rather than being silently ignored. See `UTILITIES.md` for
-details.
+belongs in `bin/orphan-pages-baseline.json` with a note, rather than being silently ignored. See
+[UTILITIES.md](./readme/UTILITIES.md) for details.
 
 Vale linting (style):
 

README.md

@@ -8,14 +8,14 @@ This repository contains a large chunk of the Temporal information corpus.
 
 | Resource                                   | Audience                |
 |--------------------------------------------|--------------------------|
-| [Information architecture](./INFORMATION-ARCHITECTURE.md) | For contributors and maintainers |
-| [Contact information](./CONTACT.md)        | For our open source community |
-| [Contributing guidance](./CONTRIBUTING.md) | For our open source community |
+| [Information architecture](./readme/INFORMATION-ARCHITECTURE.md) | For contributors and maintainers |
+| [Contact information](./readme/CONTACT.md)        | For our open source community |
+| [Contributing guidance](./readme/CONTRIBUTING.md) | For our open source community |
 | [License](./LICENSE.md) | For our open source community |
-| [React Component catalog and guidance](./COMPONENTS.md) | For our open source community |
-| [Readability tooling guidance](./READABILITY.md) | For repo maintainers |
-| [Style guidance](./STYLE.md)               | For our open source community |
-| [Utility tooling guidance](./UTILITIES.md) | For repo maintainers |
+| [React Component catalog and guidance](./readme/COMPONENTS.md) | For our open source community |
+| [Readability tooling guidance](./readme/READABILITY.md) | For repo maintainers |
+| [Style guidance](./readme/STYLE.md)               | For our open source community |
+| [Utility tooling guidance](./readme/UTILITIES.md) | For repo maintainers |
 
 ### Current component versioning philosophy
 

plugins/markdown-pages/index.js

@@ -330,7 +330,7 @@ module.exports = function markdownPagesPlugin(context, options = {}) {
     async postBuild({ outDir }) {
       // The transformer is ESM (zero-dep, also unit-tested standalone); this
       // plugin is CommonJS, so load it via dynamic import. See
-      // scripts/mdx-to-md.mjs and MARKDOWN_PIPELINE.md.
+      // scripts/mdx-to-md.mjs and readme/MARKDOWN_PIPELINE.md.
       const { pathToFileURL } = require('url');
       const { transformMdx } = await import(
         pathToFileURL(path.join(__dirname, '../../scripts/mdx-to-md.mjs')).href

COMPONENTS.md readme/COMPONENTS.mdCOMPONENTS.md renamed to readme/COMPONENTS.md

@@ -500,7 +500,7 @@ Role: To provide a consistent component for adding, updating, and removing relea
 
 Usage:
 
-In `/src/constants`, update the [`featureReleaseTypes.js`](./src/constants/featureReleaseTypes.js) file to include the release stage for the feature you want.
+In `/src/constants`, update the [`featureReleaseTypes.js`](../src/constants/featureReleaseTypes.js) file to include the release stage for the feature you want.
 
 Example: `serverlessWorkers: "prerelease"`
 

COMPONENT_REGISTRY.md readme/COMPONENT_REGISTRY.mdCOMPONENT_REGISTRY.md renamed to readme/COMPONENT_REGISTRY.md

@@ -23,7 +23,7 @@ We’re always happy to help and look forward to hearing from you!
 We believe strongly in Open Source and encourage contributions to our documentation. If you’d like to contribute or help us improve, these links may help:
 
 - **About the docs**: Learn more about the documentation structure and how we maintain it by visiting the [documentation overview](https://github.com/temporalio/documentation/blob/main/README.md).
-- **Contributing**: Check out our [Contributing Guidelines](https://github.com/temporalio/documentation/blob/main/CONTRIBUTING.md) for how to get started with contributing to the Temporal documentation or codebase.
+- **Contributing**: Check out our [Contributing Guidelines](https://github.com/temporalio/documentation/blob/main/readme/CONTRIBUTING.md) for how to get started with contributing to the Temporal documentation or codebase.
 - **We’re Hiring**: Interested in joining the Temporal team? We’re always looking for passionate individuals. Explore open positions at [Temporal Careers](https://temporal.io/careers).
 
 ---

CONTACT.md readme/CONTACT.mdCONTACT.md renamed to readme/CONTACT.md

@@ -79,7 +79,7 @@ Maintainers and contributors to this project are expected to conduct themselves
 
 This repository and its contents are open-source; individual and commercial use are permitted.
 
-[MIT License](./LICENSE.md)
+[MIT License](../LICENSE.md)
 
 
 # File a Github Issue