Skip to content

docs: add maintainer-facing bank README.md (fixes #99) - #177

Open
emberb170d wants to merge 6 commits into
Create-Python-App:mainfrom
emberb170d:docs/translate-authoring-md-spanish-issue-117
Open

docs: add maintainer-facing bank README.md (fixes #99)#177
emberb170d wants to merge 6 commits into
Create-Python-App:mainfrom
emberb170d:docs/translate-authoring-md-spanish-issue-117

Conversation

@emberb170d

Copy link
Copy Markdown
Contributor

Adds a maintainer-facing bank README.md documenting financial data management template structure, usage, and best practices. Links the new reference from the main README template table. Fixes#99.

…p#117
- Link docs/AUTHORING.es.md from README.md Documentation table
- Link Spanish doc from CONTRIBUTING.md with canonical English note
- Add CI L0-L3 brief mention to docs/AUTHORING.es.md intro
Addresses acceptance criteria for issue Create-Python-App#117:
- [x] Spanish doc exists and is linked
- [x] English remains canonical
- [x] Mentions CI L0-L3 briefly
…ate-Python-App#112)
Defines the standard span kinds and attribute schema AI extensions must use
when emitting LLM/tool/retrieval/guardrail spans via the primitives from
fastapi-mlflow-tracing (Create-Python-App#81).
- Documents 4 span kinds: llm_inference, tool_call, retrieval, guardrail_check
- Specifies required attributes for each kind
- Defines span shape rules (linear span tree for guardrail rejections)
- Documents privacy policy (LLM_TRACE_PAYLOAD opt-in, off in CI)
- Links all related issues (Create-Python-App#81, Create-Python-App#77, Create-Python-App#78, Create-Python-App#79, Create-Python-App#80, Create-Python-App#82, Create-Python-App#91)
- Includes illustrative Python example using maybe_start_span
@coderabbitai

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 2b4e9fdb-603b-4da7-88aa-80d91ba16d5b


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ulises-jeremias

Copy link
Copy Markdown
Member

The bank README addresses #99 nicely — thanks. Before review can proceed, the branch needs trimming: it carries unrelated changes (.editorconfig / .python-version sweeps across templates, plus CONTRIBUTING.md / docs/* edits that overlap with #162), and several of those files were also modified on main after this branch was cut.

Please rebase onto the latest main and reduce the diff to just docs/bank-README.md (and a link from the root README.md if that's intentional). Then it's a quick merge.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(uv-workspace-starter): add maintainer-facing bank README.md

2 participants

@emberb170d@ulises-jeremias