Skip to content

chore/add-readme-info-in-adition-to-agentsmd #2050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sushmangupta merged 3 commits into from
Dec 18, 2025
Merged

chore/add-readme-info-in-adition-to-agentsmd #2050

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8baba8
chore/add-readme-info-in-adition-to-agentsmd
Isengo1989 Dec 18, 2025
e7dd844
Update README.md
sushmangupta Dec 18, 2025
cd057b9
Merge branch 'main' into add/redirect-info
sushmangupta Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@ Refer to its [structure](./index.md) to understand better. Contributions to impr

![Developer docs](./assets/developer-docs.png)

## Redirects

Redirects from old URLs to new ones are managed via the [`.gitbook.yaml`](./.gitbook.yaml) file. This ensures continued access to content after pages are renamed or relocated.

When deleting, moving or renaming pages, compare your branch against `main`, identify the moved files, and add corresponding redirects to `.gitbook.yaml` following the existing patterns.

```yaml
# Example redirect FROM concepts/framework/rules.html TO concepts/framework/rule/index.html
concepts/framework/rules.html: concepts/framework/rule/index.html
```

## Workflows

They are defined in the [`.github/workflows`](./.github/workflows/) folder and help the DX team to maintain the documentation. The workflows are triggered by events like `push`, `pull_request`, `schedule` and `workflow_dispatch`. The workflows are used to build, test, and deploy the documentation. If a PR pipeline fails, the PR will be marked as failed, and it won't be possible to merge it. In this case, check the below-mentioned workflows to see what went wrong and where to fix it.
Expand Down