Skip to content

Commit 6d02391

Browse files
committed
[DOC] rel v4.3.1
1 parent 99cd209 commit 6d02391

49 files changed

Lines changed: 7222 additions & 1670 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ A brief description of what this PR does.
2626
- [ ] `CHANGELOG.md` updated
2727
- [ ] `README.md` updated (if adding a major feature)
2828
- [ ] `llms.txt` and `llms-full.txt` updated (if changing the public API or architecture)
29-
- [ ] Documentation in `doc/` updated (if applicable)
29+
- [ ] Documentation in `docs/` updated (if applicable)
3030

3131
## Related Issues
3232

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -367,17 +367,18 @@ OPCUA_AUTH_TOKEN=$(cat /etc/opcua/daemon.token) php bin/opcua-session-manager \
367367

368368
## Documentation
369369

370-
| # | Document | Covers |
371-
|---|----------|--------|
372-
| 01 | [Introduction](doc/01-introduction.md) | Overview, requirements, quick start |
373-
| 02 | [Overview & Architecture](doc/02-overview.md) | Problem, solution, components |
374-
| 03 | [Installation](doc/03-installation.md) | Requirements, Composer setup, project structure |
375-
| 04 | [Daemon](doc/04-daemon.md) | CLI options, security, systemd/Supervisor, internals |
376-
| 05 | [ManagedClient API](doc/05-managed-client.md) | Full API reference, configuration, session persistence |
377-
| 06 | [IPC Protocol](doc/06-ipc-protocol.md) | Transport, commands, authentication, wire format |
378-
| 07 | [Type Serialization](doc/07-type-serialization.md) | JSON conversion for all OPC UA types and DTOs |
379-
| 08 | [Testing](doc/08-testing.md) | Test infrastructure, helper class, running tests |
380-
| 09 | [Examples](doc/09-examples.md) | Complete code examples for all features |
370+
Full documentation is available in [`docs/`](docs/index.md). Highlights:
371+
372+
| Section | Covers |
373+
|---------|--------|
374+
| **Getting started**[Overview](docs/overview.md) · [Installation](docs/getting-started/installation.md) · [Quick start](docs/getting-started/quick-start.md) · [Why a session manager](docs/getting-started/why-a-session-manager.md) | Concepts, install, motivation |
375+
| **Daemon**[Starting](docs/daemon/starting.md) · [Configuration](docs/daemon/configuration.md) · [Transports](docs/daemon/transports.md) · [Authentication](docs/daemon/authentication.md) · [Security hardening](docs/daemon/security-hardening.md) · [Logging & cache](docs/daemon/logging-and-cache.md) · [Auto-connect](docs/daemon/auto-connect.md) · [Auto-publish](docs/daemon/auto-publish.md) · [As a service](docs/daemon/running-as-a-service.md) | CLI, config, transports, systemd/Supervisor |
376+
| **ManagedClient**[Overview](docs/managed-client/overview.md) · [Opening & closing](docs/managed-client/opening-and-closing.md) · [Session reuse](docs/managed-client/session-reuse.md) · [Differences from direct client](docs/managed-client/differences-from-direct-client.md) | API surface, lifecycle, session persistence |
377+
| **IPC**[Overview](docs/ipc/overview.md) · [Envelope & framing](docs/ipc/envelope-and-framing.md) · [Commands](docs/ipc/commands.md) · [Type serialization](docs/ipc/type-serialization.md) · [Direct interaction](docs/ipc/direct-interaction.md) | Wire protocol, commands, JSON conversion |
378+
| **Extensibility**[Custom param deserializer](docs/extensibility/custom-param-deserializer.md) · [Third-party modules](docs/extensibility/third-party-modules.md) | Plugin points |
379+
| **Testing**[Overview](docs/testing/overview.md) | Test infrastructure |
380+
| **Reference**[Daemon CLI](docs/reference/daemon-cli.md) · [ManagedClient API](docs/reference/managed-client-api.md) · [IPC commands](docs/reference/ipc-commands.md) · [Exceptions](docs/reference/exceptions.md) | Full API reference |
381+
| **Recipes**[Upgrading to v4.3](docs/recipes/upgrading-to-v4.3.md) · [Persistent sessions in Laravel](docs/recipes/persistent-sessions-laravel.md) · [Auto-publish pattern](docs/recipes/auto-publish-pattern.md) · [Healthcheck & monitoring](docs/recipes/healthcheck-and-monitoring.md) · [ECC secure connection](docs/recipes/ecc-secure-connection.md) · [Recovery & reconnect](docs/recipes/recovery-and-reconnect.md) · [Debugging with netcat](docs/recipes/debugging-with-netcat.md) | Task-oriented walkthroughs |
381382

382383
## Testing
383384

doc/01-introduction.md

Lines changed: 0 additions & 105 deletions
This file was deleted.

doc/02-overview.md

Lines changed: 0 additions & 76 deletions
This file was deleted.

doc/03-installation.md

Lines changed: 0 additions & 70 deletions
This file was deleted.

0 commit comments

Comments
 (0)