Skip to content

Docs: Add llms.txt to documentation site #6692

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1 task done
hjgraca opened this issue May 20, 2025 · 0 comments
Open
1 task done

Docs: Add llms.txt to documentation site #6692

hjgraca opened this issue May 20, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation triage Pending triage from maintainers

Comments

@hjgraca
Copy link
Contributor

hjgraca commented May 20, 2025

What were you searching in the docs?

Add support for llms.txt and llms-full.txt in Powertools for AWS documentation site
This will allow developers to add Powertools for AWS Lambda documentation context to their tools, IDEs, etc

Is this related to an existing documentation section?

No response

How can we improve?

Add support for llms.txt and llms-full.txt in Powertools for AWS documentation site

llms.txt will contain the links to the sections defined on the yaml
llms-full.txt will contain all the markdown text of those pages

Got a suggestion in mind?

plugins:
  - llmstxt:
      markdown_description: Powertools for AWS Lambda (Python) is a developer toolkit to implement Serverless best practices and increase developer velocity. It provides a suite of utilities for AWS Lambda Functions that makes tracing with AWS X-Ray, structured logging and creating custom metrics asynchronously easier.
      full_output: llms-full.txt
      sections:
        Project Overview:
          - index.md
          - changelog.md
          - upgrade.md
          - roadmap.md
        Core Utilities:
          - core/tracer.md
          - core/logger.md
          - core/metrics/index.md
          - core/metrics.md
          - core/metrics/datadog.md
          - core/event_handler/api_gateway.md
          - core/event_handler/appsync.md
          - core/event_handler/appsync_events.md
          - core/event_handler/bedrock_agents.md
        Utilities:
          - utilities/parameters.md
          - utilities/batch.md
          - utilities/typing.md
          - utilities/validation.md
          - utilities/data_classes.md
          - utilities/parser.md
          - utilities/idempotency.md
          - utilities/data_masking.md
          - utilities/feature_flags.md
          - utilities/streaming.md
          - utilities/middleware_factory.md
          - utilities/jmespath_functions.md
        Tutorial:
          - tutorial/index.md
        Processes:
          - security.md
          - automation.md
          - versioning.md
          - maintainers.md
        Contributing:
          - contributing/setup.md
          - contributing/getting_started.md
          - contributing/conventions.md

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@hjgraca hjgraca self-assigned this May 20, 2025
@hjgraca hjgraca added documentation Improvements or additions to documentation triage Pending triage from maintainers labels May 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation triage Pending triage from maintainers
Projects
Development

No branches or pull requests

1 participant