aws / aws/aws-cdk

CHANGELOG.v2.md file getting too big to view on GitHub

Open
#25,550 3 comments 0 reactions 0 assignees View on GitHub
bug documentation effort/small p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the bug

image

### Expected Behavior

Expect to be able to view the formatted markdown content.

### Current Behavior

GitHub says "This blob took too long to generate."

### Reproduction Steps

Click on this [link](https://github.com/aws/aws-cdk/blob/main/CHANGELOG.v2.md).

### Possible Solution

Maybe prune the file of older version info, or split it into multiple parts.

### Additional Information/Context

_No response_

### CDK CLI Version

2.79.1 (build 2e7f8b7)

### Framework Version

_No response_

### Node.js Version

v18.13.0

### OS

Windows 10

### Language

Python

### Language Version

Python 3.9.13

### Other information

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by opening CHANGELOG.v2.md from the linked GitHub page and confirm the rendering failure. Decide whether pruning older version information or splitting the changelog is appropriate, then make the formatted history viewable on GitHub and verify the resulting files render successfully.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.