Skip to content

Docs: Add llms.txt to documentation site #6692

@hjgraca

Description

@hjgraca
Contributor

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.

Activity

self-assigned this
on May 20, 2025
added
documentationImprovements or additions to documentation
triagePending triage from maintainers
on May 20, 2025
github-actions

github-actions commented on May 23, 2025

@github-actions
Contributor

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

dreamorosi

dreamorosi commented on May 23, 2025

@dreamorosi
Contributor

The build of the docs failed, it says the plugin is not properly installed.

hjgraca

hjgraca commented on May 23, 2025

@hjgraca
ContributorAuthor

@dreamorosi, @leandrodamascena was looking into it, I believe that the pipeline is not installing the dependencies in the requirements. But did not dive into it to find the issue yet

github-actions

github-actions commented on May 25, 2025

@github-actions
Contributor

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

github-actions

github-actions commented on Jun 3, 2025

@github-actions
Contributor

This is now released under 3.14.0 version!

removed
pending-releaseFix or implementation already in dev waiting to be released
on Jun 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

Status

Shipped

Milestone

No milestone

Relationships

None yet

    Participants

    @hjgraca@leandrodamascena@dreamorosi

    Issue actions

      Docs: Add llms.txt to documentation site · Issue #6692 · aws-powertools/powertools-lambda-python