Skip to content

Maintenance: Add llms.txt to documentation site #892

Open
@hjgraca

Description

@hjgraca

Summary

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

Why is this needed?

This will allow developers to add Powertools for AWS Lambda documentation context to their tools, IDEs, etc

Which area does this relate to?

No response

Solution

plugins:
  - llmstxt:
      markdown_description: Powertools for AWS Lambda (.NET) 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
          - roadmap.md
        Core Utilities:
          - core/logging.md
          - core/metrics.md
          - core/tracing.md
        Utilities:
          - utilities/idempotency.md
          - utilities/batch-processing.md
          - utilities/parameters.md
          - utilities/jmespath-functions.md
          - core/event_handler/appsync_events.md
        Getting Started:
          - getting-started/logger/simple.md
          - getting-started/logger/aspnet.md
          - getting-started/logger/aot.md

Acknowledgment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationinternalMaintenance changespending-releaseFix or implementation already in dev waiting to be released

Type

No type

Projects

Status

👀 In review

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions