Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 77 additions & 0 deletions docs/generate a changelog from your commits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@


# Generate a Changelog from Your Commits

## Step 1: Access the Dev-Docs Platform

Navigate to the Dev-Docs website and locate the "Login with GitHub" button.

![image for /img/generate_a_changelog_from_your_commits/step_1](/img/generate_a_changelog_from_your_commits/step_1.png)

## Step 2: Navigate to User-Facing Docs

After logging in, find and click on the "User-facing docs" option in the dashboard.

![image for /img/generate_a_changelog_from_your_commits/step_2](/img/generate_a_changelog_from_your_commits/step_2.png)

## Step 3: Access AI Features

Locate and click on the "More with AI" button to access advanced features.

![image for /img/generate_a_changelog_from_your_commits/step_3](/img/generate_a_changelog_from_your_commits/step_3.png)

## Step 4: Initiate Changelog Generation

Find and click on the "Generate a changelog" button to start the process.

![image for /img/generate_a_changelog_from_your_commits/step_4](/img/generate_a_changelog_from_your_commits/step_4.png)

## Step 5: Select Repository

Click on the "Select Repos" dropdown to choose the repository for which you want to generate the changelog.

![image for /img/generate_a_changelog_from_your_commits/step_5](/img/generate_a_changelog_from_your_commits/step_5.png)

## Step 6: Choose Repository

Select the checkbox next to the desired repository.

![image for /img/generate_a_changelog_from_your_commits/step_6](/img/generate_a_changelog_from_your_commits/step_6.png)

## Step 7: Configure Changelog Settings

Adjust the settings for your changelog generation, including the commit selection method and the location for the new document.

![image for /img/generate_a_changelog_from_your_commits/step_7](/img/generate_a_changelog_from_your_commits/step_7.png)

## Step 8: Select Commit Range

Choose "By Number of Last Recent Commits" to specify the range of commits to include in the changelog.

![image for /img/generate_a_changelog_from_your_commits/step_8](/img/generate_a_changelog_from_your_commits/step_8.png)

## Step 9: Submit Changelog Request

Review your settings and click the "Submit" button to generate the changelog.

![image for /img/generate_a_changelog_from_your_commits/step_9](/img/generate_a_changelog_from_your_commits/step_9.png)

## Step 10: Confirm Submission

Click on the "Submit" button to finalize and process your changelog request.

![image for /img/generate_a_changelog_from_your_commits/step_10](/img/generate_a_changelog_from_your_commits/step_10.png)

## Step 11: Review Generated Changelog

Examine the automatically generated changelog, which will be displayed in a formatted structure.

![image for /img/generate_a_changelog_from_your_commits/step_11](/img/generate_a_changelog_from_your_commits/step_11.png)

## Step 12: Copy or Edit Changelog

You can now copy the generated changelog or make any necessary edits before finalizing it for your project.

![image for /img/generate_a_changelog_from_your_commits/step_12](/img/generate_a_changelog_from_your_commits/step_12.png)