documentation-developer

KO | EN

gitlite — search

#javascript #typescript #llm #golang #go #android #java #cli #kubernetes #vue #security #mcp #openai #open-source

documentation-developer

(★ 33)

Source for the developer documentation for Ibexa DXP.

documentation-developer 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Ibexa DXP Developer Documentation

This repository is the source for the [developer documentation for Ibexa](https://doc.ibexa.co/en/latest),
a digital experience platform that is based on the Symfony Full Stack Framework in PHP.

# Resources

1. Ibexa DXP Developer Hub: https://developers.ibexa.co
1. Ibexa DXP Repository: https://github.com/ibexa/oss
1. Ibexa Website: https://ibexa.co
1. User documentation: https://doc.ibexa.co/projects/userguide

## How to contribute

To contribute to the documentation, you can open a PR in this repository.

If you'd like to see Ibexa DXP in your language, you can [contribute to the translations](https://doc.ibexa.co/en/latest/resources/contributing/contribute_translations/).

### Contribute to API reference

The REST API Reference is located in the `docs/api/rest_api/rest_api_reference/` directory.
It is based on an OpenAPI specification (`openapi.yaml` / `openapi.json`) generated from the Ibexa DXP source code.
To contribute to the REST API reference, you must modify the source code annotations directly.

## Build and preview documentation

To build and preview your changes locally, you need to install Python along with its package manager (`pip`).
Other required tools will be installed by using the following command:

```bash
pip install -r requirements.txt
```

Then you can run:

```bash
mkdocs serve
```

After a short while your documentation should be reachable at http://localhost:8000. If it isn't, check the output
of the command.

## Testing the code samples

### YAML configuration

To test the YAML configuration, run the following commands:

``` bash
composer update
composer check-yaml
```

To add an error into a baseline, run `composer yaml-update-baseline` and commit the result.
Error added to the baseline are not reported again.

### markdownlint

This repository uses [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) to check Markdown formatting, including table syntax.

Install dependencies:

```bash
yarn install
```

Run the linter:

```bash
yarn markdownlint
```

Some issues can be fixed automatically:

```bash
yarn markdownlint --fix
```

### PHPStan

This repository uses PHPStan to test the code samples. To run the tests locally execute the commands below:
```bash
composer update
composer phpstan
```

Regenerate the baseline by running:

```bash
composer phpstan-update-baseline
```

#### Skipping validation of inline PHP snippets

PHP code blocks embedded directly in Markdown files are extracted and tested with PHPStan.
To exclude a snippet from validation (for example, for an intentionally incomplete fragment), add the `skip-validation` marker to its opening fence:

````markdown
``` php {skip-validation}
```
````

If the code block uses other options, such as `hl_lines`, they must be placed **inside the same curly-brace group** as the marker:

````markdown
``` php {skip-validation hl_lines="6 14"}
```
````

Both `php {skip-validation} hl_lines="6 14"` and `php hl_lines="6 14" {skip-validation}` are rejected by the Markdown parser, and the whole code block is rendered as plain paragraph text.

### Deptrac

This repository uses Deptrac to test the code samples. To run the tests locally execute the commands below:

```bash
composer update
composer deptrac
```

Regenerate the baseline by running:

```bash
composer deptrac-update-baseline
```

## Checking links

External links in the built documentation are checked using [lychee](https://lychee.cli.rs).

### Running the link checker

```bash
# 1. Build the main docs site
mkdocs build --strict

# 2. Clone and build versioned repositories, and generate lychee.toml
./tools/clone-repositories.sh

# 3. Check links
lychee --config lychee.toml --cache --cache-exclude-status "400.." site
```

After fixing any reported links, run `mkdocs build --strict` before rerunning `lychee`.

#### Using non-standard brancges

The script accepts optional branch names before cloning repositories:

```bash
./tools/clone-repositories.sh [DEVDOC_50] [DEVDOC_46] [USERDOC_50] [USERDOC_46] [CONNECT]
```

| Argument     | Repository                      | Default |
|--------------|---------------------------------|---------|
| `DEVDOC_50`  | `ibexa/documentation-developer` | `5.0`   |
| `DEVDOC_46`  | `ibexa/documentation-developer` | `4.6`   |
| `USERDOC_50` | `ibexa/documentation-user`      | `5.0`   |
| `USERDOC_46` | `ibexa/documentation-user`      | `4.6`   |
| `CONNECT`    | `ibexa/documentation-connect`   | `main`  |

Example — checking link for release PRs:

```bash
./tools/clone-repositories.sh release-5.0.10 release-4.6.70 4.6 4.6 main
```

The same parameters are available as inputs when triggering the GitHub Actions workflow manually.

## Where to View

https://doc.ibexa.co

documentation-developer

documentation-developer 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

documentation-developer

documentation-developer 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README