docs: README in remaining component bricks (final sweep)#925
Merged
bjagg merged 1 commit intoMay 16, 2026
Conversation
Adds short READMEs to the 26 remaining bricks under components/lif/ and its sub-directories. Same template as PRs LIF-Initiative#922, LIF-Initiative#923, LIF-Initiative#924: purpose, public surface, file layout where the brick has multiple modules, and the list of consumers. Covers: - Auth + middleware: api_key_auth, auth - Data plumbing: composer, datatypes, exceptions, logging, mongodb_connection, string_utils - Schema + config: lif_schema_config, openapi_schema_parser, openapi_to_graphql, schema_state_manager - Source-adapter framework: data_source_adapters (+ two adapter subdirs: lif_to_lif_adapter and example_data_source_rest_api_to_lif_adapter) - Identity mapper trio: identity_mapper_service, identity_mapper_storage, identity_mapper_storage_sql - Service-specific: example_data_source_service, graphql_client, langchain_agent (+ prompts/), semantic_search_service, translator - Tenant routing pure helpers: tenant_routing - Subdirs: langchain_agent/prompts (5 prompt templates), mdr_client/resources (bundled OpenAPI snapshot) cspell: add getenv, inlines, isinstance. Closes out the Tier 1 README sweep across bases/ and components/.
github-project-automation
Bot
moved this from Backlog
to Done
in Current Community Efforts
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
1 participant
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
Tier 1 README sweep, batch 4 of 4 — closes out the goal of "every directory that has at least a file or two has a README". Adds 26 short READMEs across the remaining component bricks and a few subdirectories.
Coverage
Wrapping up the sweep
After this merges, the only missing README under
bases/lif/islearner_data_export_api/— which will land with cbeach's open PR #920.Test plan
uv run pre-commit run cspell --files <new READMEs>passes🤖 Generated with Claude Code