Repository navigation
Conversation
The discrepancies notes of E3AP, E2SM-DAPP and E3SM-SPEC list where the implementations and the grammar disagree. They change with the code, not with the specification, so they stay in the Markdown and the Word editions are complete without them. * A manifest names such files in the optional field markdown_only. The three manifests name 06-discrepancies.md and drop it from their parts. The Spectrum examples become Annex A. * build_docx.py leaves out every reference to a Markdown-only file: a "see" clause in parentheses or after a comma, the sentence that holds the link, and a table row whose cell is only the link. * The discrepancies notes call themselves informative notes, not annexes or sections of the specification. The Spectrum mentions of "Annex A" that meant the discrepancies note are links to it, and the Spectrum examples and the integrator guide say Annex A. The three Word editions are rebuilt in the container. E3SM-L1-KPM has no discrepancies note and is unchanged. Assisted-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Contributor
CI report —
|
| Workflow | Result | Time | Run |
|---|---|---|---|
| Commit policy | ✅ success (steps skipped — no code changes) | 0m20s | #229 |
| Docs | ✅ success | 0m26s | #30 |
| Build libe3py wheels | ⏭️ not started (no changed file matches its paths filter) |
— | — |
| E2E dApp Integration | ⏭️ not started (no changed file matches its paths filter) |
— | — |
| E2E Topologies (multi-dApp / multi-RAN) | ⏭️ not started (no changed file matches its paths filter) |
— | — |
| Full-loop Latency Benchmark | ⏭️ not started (no changed file matches its paths filter) |
— | — |
| latrec portability | ⏭️ not started (no changed file matches its paths filter) |
— | — |
| MPMC Queue Benchmark | ⏭️ not started (no changed file matches its paths filter) |
— | — |
| Unit Tests | ⏭️ not started (no changed file matches its paths filter) |
— | — |
Docs
Doxygen warnings
0 warning(s) in the files this pull request changes, which fail the check; 403 more elsewhere, which do not. The full list is in the job log and the doxygen-warnings artifact of the Docs workflow.
Gaps in files this pull request does not change, by file:
| Warnings | File |
|---|---|
| 53 | include/libe3/types.hpp |
| 37 | include/libe3/sm_interface.hpp |
| 35 | include/libe3/e3_connector.hpp |
| 34 | include/libe3/e3_agent.hpp |
| 32 | include/libe3/e3_interface.hpp |
| 29 | include/libe3/c_api.h |
| 19 | src/c_api.cpp |
| 17 | include/libe3/logger.hpp |
| 17 | swig/libe3_swig.hpp |
| 17 | swig/e3_dapp_session.hpp |
Ready to merge (fast-forward only)
A maintainer can land the reviewed commits with:
git fetch origin
git checkout main && git merge --ff-only 4eb894b82b86116a8afb240985a70d7baef885a8 && git push origin mainHead: 4eb894b82b86116a8afb240985a70d7baef885a8 (branch docs/oran-docx-markdown-only). If --ff-only fails as non-fast-forward, the branch must be rebased on the latest main.
One comment per PR, rewritten in place once every workflow for
4eb894bfinished.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Discrepancies stay in Markdown. The
06-discrepancies.mdnotes of E3AP, E2SM-DAPP and E3SM-SPEC track where implementations and the grammar disagree. They change with the code, not with the specification, so they are no longer part of the Word editions. They stay in the repository as Markdown. Each Word edition is now standalone.No dangling references. A manifest lists such files in the optional field
markdown_only.build_docx.pyremoves every reference to them: a "see" clause in parentheses or after a comma, the sentence that holds the link, and a table row whose cell is only the link. Examples:`1` (one implementation announces `0`, see [06](06-discrepancies.md))1(one implementation announces0)…can fail. See [06-discrepancies.md](06-discrepancies.md).Annex letters. E3AP and E2SM-DAPP have no annex now. In E3SM-SPEC, the examples become Annex A, and the Markdown matches: the examples note and the integrator guide say Annex A, and the plain-text "(Annex A)" mentions of the discrepancies note are now links to it. The discrepancies notes call themselves informative notes instead of annexes or sections.
E3AP, E2SM-DAPP and E3SM-SPEC are rebuilt in the
tools/oran_docxcontainer. E3SM-L1-KPM has no discrepancies note and is unchanged. Every edited sentence in the rebuilt editions was read, and none of them contains "discrepanc" or a Markdown file name.Type of change
Linked issue
No issue is open for this change. It touches only the documentation and its Word tooling.
Twin-repo coordination
libe3 is paired with
dappsanddApp-openairinterface5g. We do not accept patches that break or reduce compatibility with the twin repositories.docs/interop.md.Paired PR(s): none needed (documentation only).
🤖 Generated with Claude Code