Skip to content

fix(docs): correct heading hierarchy and Table of Contents in quickstart samples#780

Open
Srinu346 wants to merge 3 commits intokeploy:mainfrom
Srinu346:fix/quickstart-toc
Open

fix(docs): correct heading hierarchy and Table of Contents in quickstart samples#780
Srinu346 wants to merge 3 commits intokeploy:mainfrom
Srinu346:fix/quickstart-toc

Conversation

@Srinu346
Copy link
Contributor

@Srinu346 Srinu346 commented Feb 3, 2026

What has changed?

This PR fixes incorrect heading hierarchies across multiple documentation pages that were causing the right-side Table of Contents to appear misaligned and inconsistent. Headings have been updated to follow a proper structure, and section titles were corrected so the Table of Contents accurately reflects the page content wherever the issue was repeated.

This PR resolves #3713

Type of change

  • Documentation update (if none of the other choices apply).

How Has This Been Tested?

  • Ran npm run build to ensure the documentation builds successfully without errors.
  • Manually verified that headings and the left-side Table of Contents are properly aligned and consistent across affected pages.
  • Visually inspected pages to confirm improved navigation and structure.

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

Screenshots

  • Before
image
  • After
image

Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
@Srinu346 Srinu346 changed the title fix(docs):samples-tableofcontent fix(docs): correct heading hierarchy and Table of Contents in quickstart samples Feb 3, 2026
@Achanandhi-M
Copy link
Member

Hey @Srinu346 can you please add video of your changes, i couldn't able to see any changes from the screenshot

@Srinu346
Copy link
Contributor Author

Srinu346 commented Feb 4, 2026

@Achanandhi-M sir,

Here is a short video

  • Before Changes
Screen.Recording.2026-02-04.150402.mp4

Sir as you can see here the right side table of content block is mixed of both docker compose steps and wsl steps.

It is not alone in the Echo SQL Sample section, so where ever the issue is getting repeated i have modified them properly. It solved
the issue as you can see in the after changes video or screenshot.

Copy link
Member

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Srinu346, the changes look good. However, I noticed that no updates were made for the FastHTTP + Postgres setup. Could you please let me know why there are no changes there?

Image

@Srinu346
Copy link
Contributor Author

Srinu346 commented Feb 4, 2026

@Achanandhi-M sir, i already have a ongoing pr for FastHTTP + Postgres Setup so i avoided that in this pr.

@Achanandhi-M
Copy link
Member

Achanandhi-M commented Feb 4, 2026

@Achanandhi-M sir, i already have a ongoing pr for FastHTTP + Postgres Setup so i avoided that in this pr.

In that case, please don’t create a PR and request a review until the changes are fully completed. Kindly raise the PR once everything has been addressed. @Srinu346

@Srinu346
Copy link
Contributor Author

Srinu346 commented Feb 4, 2026

Ok Sir, i will wait until the previous pr is completely merged or closed, then will look into this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix(docs): align headings and Table of Contents in quickstart samples

2 participants