Skip to content

Docs: only one non-obvious link to github on a page, and it is broken #220

Closed
@huonw

Description

@huonw

What were you initially searching for in the docs?

A link to the repository in order to look at the source code for the aws_lambda_powertools.utilities.typing.LambdaContext class.

Is this related to an existing part of the documentation? Please share a link

I started on a subpage https://awslabs.github.io/aws-lambda-powertools-python/utilities/typing/ and then moved to the homepage https://awslabs.github.io/aws-lambda-powertools-python/ .

Describe how we could make it clearer

I think there's two issues here:

  1. the "Edit on Github" link (that is nominally for editing the documentation) in the sidebar is broken. For instance, neither of the pages linked work:
  2. there's no obvious "here's the repository" link on either of those pages (or any others)

If you have a proposed update, please share it here

  1. fix the links, which might require wrangling gatsby to use develop/docs instead of HEAD
  2. many projects have a link to their repository as part of the docs template, and so visible on every page; for instance, one or more of:

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

Status

Triage

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions