Repository navigation
chore: docs and cleanup - #31
Merged
Merged
Conversation
phine-lukas
force-pushed
the
chore-docs-and-cleanup
branch
2 times, most recently
from
August 31, 2026 12:55
880736a to
3f279bb
Compare
phine-lukas
marked this pull request as draft
August 31, 2026 14:40
phine-lukas
force-pushed
the
chore-docs-and-cleanup
branch
from
August 31, 2026 14:58
3f279bb to
784ed6b
Compare
phine-lukas
marked this pull request as ready for review
August 31, 2026 15:00
phine-lukas
force-pushed
the
chore-docs-and-cleanup
branch
from
August 31, 2026 15:39
dab27da to
ed47a0d
Compare
Add CONTRIBUTING (DCO sign-off, draft-PR workflow) and issue templates; polish README with badges, docs link (af.phine.tech) and CAMARA APIs table. Sweep OAI leftovers from our code, config and paths (/var/log/oai/af → /var/log/phine.af, /etc/oai/af → /etc/phine.af); rename "Northbound Adapters" → "Northbound APIs" and unify images + containers under the phine.af-* family. Consolidate logging config (file sink tracked in #13). Co-authored-by: Cloude Opus 4.7 Signed-off-by: Lukas Rotheneder <lukas.rotheneder@phine.tech>
Bypass fragile llvm.sh script in Dockerfiles to prevent Cloudflare HEAD request failures (exit code 4) during clang-tidy installation. Co-authored-by: Gemini 3.1 Pro Signed-off-by: Lukas Rotheneder <lukas.rotheneder@phine.tech>
Signed-off-by: Lukas Rotheneder <lukas.rotheneder@phine.tech>
phine-lukas
force-pushed
the
chore-docs-and-cleanup
branch
from
September 1, 2026 10:59
a39c96b to
e85fa03
Compare
Delete the workflow_call-only integration-tests.yml (never wired into ci.yml) and the ci_helper.sh functions that referenced the missing docker-compose-test.yaml. Point docs/getting-started/02-build.md at build_standalone (matches its --clean/--debug/--tests flags) and switch 08-demo-adapter-tutorial.md's CI Quick Run to the same runme invocation test-tutorials.yml uses. Assisted-by: Claude Opus 4.7 Signed-off-by: Lukas Rotheneder <lukas.rotheneder@phine.tech>
- Bump actions/checkout v4 → v5 and actions/upload-artifact v4 → v5 across all workflows to move off the deprecated Node 20 runtime. - Bump github/codeql-action/upload-sarif v2 → v3 (v1/v2 deprecated). - Add security-events: write permission to the Trivy security-scan job so SARIF upload works once CodeQL is enabled post-open-sourcing; resolves 'Resource not accessible by integration' errors. Assisted-by: Claude Opus 4.7 Signed-off-by: Lukas Rotheneder <lukas.rotheneder@phine.tech>
phine-lukas
force-pushed
the
chore-docs-and-cleanup
branch
from
September 1, 2026 14:02
1bbf4d7 to
c8b9350
Compare
Signed-off-by: Lukas Rotheneder <lukas.rotheneder@phine.tech>
tariromukute
approved these changes
Sep 8, 2026
…SSWORD secrets Signed-off-by: Lukas Rotheneder <lukas.rotheneder@phine.tech>
Signed-off-by: Lukas Rotheneder <lukas.rotheneder@phine.tech>
tariromukute
self-requested a review
September 8, 2026 15:10
tariromukute
approved these changes
Sep 8, 2026
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.
Description
Open-source readiness pass for
phine.af: polishes the public face (README, badges, docs link, CAMARA APIs table), adds contribution scaffolding (CONTRIBUTING with DCO sign-off, issue templates), sweeps stale OAI references out of our code/config/paths (upstream OAI submodule and OAI compose demos intentionally kept), consolidates the logging config schema without changing runtime behavior, re-syncs the architecture diagram, and unifies all first-party image names under thephinetech/phine.af-*prefix.Related Issues
Related to: #13
Changes Made
Added
CONTRIBUTING.md— DCO sign-off requirement and draft-PR-first workflow..github/ISSUE_TEMPLATE/— Bug Report, Feature Implementation, Task/Scope templates +config.yml(disables blank issues, links to docs & discussions).README.md— CI / Apache-2.0 / CAMARA-compliant badge row, link to https://af.phine.tech/, and a CAMARA APIs table (QoD →camaraproject/QualityOnDemand).logging:blocks pointing at [TECH DEBT] Restore and enhance logging infrastructure #13.Changed
/adapters/*demos).docs/diagrams/architecture.mmdupdated and re-synced intoREADME.mdanddocs/architecture/overview.mdviabuild/scripts/sync_diagrams.sh.docs/index.mdanddocs/architecture/repository-layout.mdrewritten to match the current layout; stale TODO markers cleared across ~9 doc pages.docs/reference/configuration-reference.mdanddocs/development/configuration.mdrewritten to explain the modern vs. legacy schema and Compose mount points.config/af.yaml— de-duplicatednef_handler:/udr_handler:blocks.phine.af-*family incompose.yaml,docker-compose/compose*.yaml,.github/workflows/publish.yml, and README build examples:phinetech/pcf-handler→phinetech/phine.af-pcf-handlerphinetech/af-core→phinetech/phine.af-corephinetech/af-api→phinetech/phine.af-apiphinetech/af-demo-qod→phinetech/phine.af-demo-qodphinetech/demo-qod-adapter→phinetech/phine.af-demo-qod-adapterphinetech/af(bundled) →phinetech/phine.afsrc/main.cpp,af_core/,northbound/api_component/,southbound/pcf_handler/,adapters/demo-qod-adapter/,config/**,docker-compose/conf/**:/var/log/oai/af/*→/var/log/phine.af/*/etc/oai/af/*→/etc/phine.af/*.github/PULL_REQUEST_TEMPLATE.md— dropped inapplicable OAI/Free5GC test-env rows.Fixed
nef_handler:/udr_handler:blocks inconfig/af.yaml.Testing
Notes:
CI/CD Status