aws / aws/aws-cdk

[aws-cdk] Ability to easily access the historical versions of the API documentation

Open
#11,172 2 comments 23 reactions 0 assignees View on GitHub
documentation effort/large feature-request p3
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

https://docs.aws.amazon.com/cdk/api/latest/versions.html

It would be really helpful to have access to the previous releases here rather than having to pull the docs from the repo history.

I'd like to be able to access both:

`https://docs.aws.amazon.com/cdk/api/latest/docs/aws-appmesh-readme.html`

and

`https://docs.aws.amazon.com/cdk/api//docs/aws-appmesh-readme.html`

in the event that a given feature wasn't available in that release, I'd just expect to get a 404

---

This is a 📕 documentation issue

Contributor guide

Open the contributing guide

Research direction

Start with the documentation entry points at the versions page and the latest and release-specific aws-appmesh-readme.html URLs. Trace how AWS CDK API documentation is published and versioned, then verify that historical release URLs resolve where documentation exists and return 404 otherwise.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
cloud, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.