fix(docs): correct heading hierarchy and Table of Contents in quickstart samples#780
fix(docs): correct heading hierarchy and Table of Contents in quickstart samples#780Srinu346 wants to merge 5 commits intokeploy:mainfrom
Conversation
Signed-off-by: Akella Srinivas <alsrinivas.346@gmail.com>
|
Hey @Srinu346 can you please add video of your changes, i couldn't able to see any changes from the screenshot |
|
@Achanandhi-M sir, Here is a short video
Screen.Recording.2026-02-04.150402.mp4Sir 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 |
Achanandhi-M
left a comment
There was a problem hiding this comment.
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?
|
@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 |
|
Ok Sir, i will wait until the previous pr is completely merged or closed, then will look into this. |
amaan-bhati
left a comment
There was a problem hiding this comment.
PR Review — fix(docs): correct heading hierarchy and Table of Contents in quickstart samples
The heading hierarchy fix is correct and the approach is the right one — adding a proper H1 and demoting subsections to H2 directly addresses the malformed TOC issue.
A few things need to be addressed before this is ready to merge:
Issues Found
1. Typos introduced in samples-echo.md
The added H1 heading reads:
Echo and PostgresSQL Sample URL Shortner
Please fix:
PostgresSQL→PostgreSQLShortner→Shortener
2. Incomplete fix — FastHTTP + Postgres
The reviewer previously noted that the PR should not be submitted until all changes are complete. If a separate PR already covers the FastHTTP + Postgres file, please link it here explicitly and confirm the reviewer is aligned on the split before this is merged.
3. Scope — older versions not covered
Please confirm whether the same heading hierarchy issue exists in version-2.0.0 and version-3.0.0 quickstart files, or explicitly state those are out of scope for this PR.
🤖 Review generated by Claude Code, approved and posted by @amaan-bhati
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
How Has This Been Tested?
npm run buildto ensure the documentation builds successfully without errors.Checklist:
Screenshots