Skip to content

Comments

docs/tests: fix remaining dead links and add empty-config export test#2

Merged
oib merged 2 commits intomainfrom
codex/analyze-codebase-and-suggest-improvements-6omr61
Feb 17, 2026
Merged

docs/tests: fix remaining dead links and add empty-config export test#2
oib merged 2 commits intomainfrom
codex/analyze-codebase-and-suggest-improvements-6omr61

Conversation

@oib
Copy link
Owner

@oib oib commented Feb 17, 2026

Motivation

  • Finish follow-up review items by repairing remaining broken internal docs links and adding a regression test for an empty config export scenario.
  • Ensure the config export behavior remains robust for an empty YAML file by adding a test that captures the expected output.
  • Remove the now-obsolete proposal document once fixes are applied in-code.

Description

  • Updated docs/8_development/1_overview.md to replace non-existent internal links with existing targets and corrected the issue tracker URL and several Next Steps/Contributing links.
  • Added test_export_empty_yaml to tests/cli/test_config.py to verify that an empty .aitbc.yaml exported with --format json returns an empty JSON object ({}).
  • Deleted docs/issues/2026-02-17-codebase-task-vorschlaege.md as the actionable items were implemented.

Testing

  • Executed PYTHONPATH=cli pytest -q tests/cli/test_config.py which completed successfully with 31 passed.
  • Performed a local markdown link existence check against docs/8_development/1_overview.md which reported no missing local links.
  • Verified the repository status and committed the changes as a single change-set containing the doc updates, test addition, and deletion of the obsolete issue file.

Codex Task

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9c8ec21479

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


with open(config_file) as f:
config_data = yaml.safe_load(f)
config_data = yaml.safe_load(f) or {}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Default only null YAML to empty config

Using yaml.safe_load(f) or {} coerces any falsy top-level YAML value (for example [], false, 0, or "") into {}. In those inputs, config export now silently changes the data instead of exporting what is actually on disk, and users who re-import the export can overwrite their config shape unintentionally. The empty-file fix should only apply when safe_load returns None.

Useful? React with 👍 / 👎.

### Python Environment Details

All Python services in the AITBC container run on **Python 3.11+** with isolated virtual environments:
All Python services in the AITBC container run on **Python 3.8+** with isolated virtual environments:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep documented Python minimum aligned with runtime

This change documents the infrastructure runtime as Python 3.8+, but service code uses syntax that is not valid on 3.8 (for example built-in generics like dict[str, ...] in apps/coordinator-api/src/app/routers/admin.py). Operators following this guide can provision an unsupported interpreter and hit syntax errors at startup, so the documented minimum here should match the actual service runtime requirement.

Useful? React with 👍 / 👎.

@oib oib merged commit 85a7458 into main Feb 17, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant