docs: OpenSSF Passing accreditation — website content, license, docs/, reference - #97
Merged
Merged
Conversation
…n requirements (OpenSSF Bronze) Addresses four OpenSSF Bronze "Basic project website content" criteria: - MUST succinctly describe what the software does: replace generic tagline with a problem-statement-focused opening paragraph - MUST provide info on how to obtain, provide feedback, and contribute: add "Obtaining the software" and "Feedback and contributing" sections near the top - Contribution info MUST explain the contribution process (URL): CONTRIBUTING.md already covers PRs and DCO; link made prominent in new top-level section - Contribution info SHOULD include requirements for acceptable contributions (URL): add explicit "Requirements for acceptable contributions" section to CONTRIBUTING.md listing DCO, type-check, build, test, audit, and style gates Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Paradoxbound <paradoxbound@users.noreply.github.com>
…enSSF Bronze) Addresses OpenSSF Bronze FLOSS license criteria: - Software MUST be released as FLOSS: MIT (OSI-approved) - License MUST be posted in a standard location: LICENSE at repo root (unchanged) - Update README License section to hyperlink the LICENSE file directly and note the SPDX identifier and OSI approval, satisfying the URL requirement Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Paradoxbound <paradoxbound@users.noreply.github.com>
Creates docs/reference.md with complete input/output documentation for all 45 MCP tools. Covers common patterns (pagination, sorting, filters, response enhancement) then documents each tool with an input parameter table (name/type/required/constraints/description) and output description. Updates the README "Available Tools" section to link to the reference doc rather than duplicating the full tool list inline. Satisfies OpenSSF Bronze "reference documentation for external interface" criterion. URL: docs/reference.md Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Paradoxbound <paradoxbound@users.noreply.github.com>
Creates docs/ folder with flat structure (no subdirectories needed at
this scale). Moves content out of CLAUDE.md and the repo root:
- docs/architecture.md — monorepo structure, data flow, components,
types, design decisions, migration history
- docs/ci-cd.md — pipeline job sequences, version tagging,
branch protection rules, SLSA, Trivy caching
- docs/librechat-integration.md — moved from LIBRECHAT_INTEGRATION.md,
updated internal links to docs/ paths
Slims CLAUDE.md: replaces Architecture, CI/CD Pipeline, and Migration
sections with one-line pointers to the new docs/ files. Claude Code
specific content (build commands, key implementation details, common
workflows, debugging, future plans) stays in CLAUDE.md.
Deletes LIBRECHAT_INTEGRATION.md from the repo root.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Paradoxbound <paradoxbound@users.noreply.github.com>
Both docs/architecture.md and README.md "Project Structure" sections showed only the packages/ subtree. Update both diagrams to reflect the full repository layout including the new docs/ directory and root files. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Paradoxbound <paradoxbound@users.noreply.github.com>
Shows progress towards the CII Best Practices (Bronze/Silver/Gold) badge alongside the existing OpenSSF Baseline Level 3 badge. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Paradoxbound <paradoxbound@users.noreply.github.com>
stealthycat88
approved these changes
Mar 9, 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
2 participants
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
Batch of documentation changes to satisfy OpenSSF CII Best Practices Passing criteria and restructure the project documentation.
OpenSSF Passing criteria addressed:
docs/reference.md— complete tool reference for all 45 MCP tools (input/output) satisfying the "reference documentation for external interface" criterionDocumentation restructure:
docs/folder (flat, no subdirectories) with four files:docs/reference.md— 45-tool API reference with input parameter tables and output descriptionsdocs/architecture.md— monorepo structure, data flow, components, types, design decisions, migration historydocs/ci-cd.md— CI/CD pipeline job sequences, branch protection rules, version tagging, SLSAdocs/librechat-integration.md— moved fromLIBRECHAT_INTEGRATION.mdat repo rootCLAUDE.md: Architecture, CI/CD Pipeline, and Migration sections replaced with one-line pointers todocs/LIBRECHAT_INTEGRATION.mdfrom repo root (content indocs/librechat-integration.md)docs/architecture.mdto includedocs/Test plan
docs/reference.mdrenders correctly on GitHubdocs/architecture.mdstructure diagram is accurate🤖 Generated with Claude Code