-
Notifications
You must be signed in to change notification settings - Fork 244
Fix: Formatting issue in Docs Page [Installation Section] #686
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you and congratulations 🎉 for opening your very first pull request in keploy
27eb3c9
to
18c9a98
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @AryanCruise can you please update the PR title, also please don't update everything for the installation tab, format only the part which is not formatted properly
Thanks for the feedback! I can definitely update the title. I'm happy to reduce the scope of this PR to align with the original issue. The reason I made the extra changes was that I found the same formatting error occurred in several other places, and I thought it would be best to fix them all at once for consistency. |
cf0213c
to
b7623cd
Compare
Made the changes, as asked by you @Achanandhi-M (do let me know if any changes are required) Before:![]() After:![]() npm run build and npm run serve (screenshot):![]() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @AryanCruise can you please fix the same issue in the windows installation section, please make sure the formatting is good for every OS installation
aef7c24
to
dcbf09b
Compare
In my recent commit, I ensured that the formatting was good and consistent across all OSs on the installation page.This commit standardizes the layout to improve readability and ensure a consistent user experience across Windows, macOS, and Linux. Kindly please review the changes @Achanandhi-M |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @AryanCruise,
I’ve reviewed your PR — the 🎬 Start Capturing Test Cases section should be aligned properly with the previous section. In the current PR, the alignment isn’t consistent. Please fix the formatting issue. For reference, check the current live section and make the same changes there too.
e80f5ee
to
bd7a8e8
Compare
I have formatted as mentioned by adding a margin before the code blocks and giving numbering for each step. Kindly review it @Achanandhi-M |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @AryanCruise I think we don't want the changes in the components folder
But, that's the only way to format the 🎬 Start Capturing test cases section as mentioned by you earlier to make changes in it. I have searched for a .md file for that, unlike the installation_tabs.md file in which I made changes earlier, but I haven't found one. I think that section is directly made in .js without using a .md file. |
Hey @AryanCruise Our requirement is too align everything equally in the page, but in this current PR the installation section and the capturing test cases not formatted equally i am asking you to make it properly aligned for that you don't need to update any js file |
Signed-off-by: Aryan Nair <[email protected]>
bd7a8e8
to
f61e2e3
Compare
src/css/custom.css
Outdated
} | ||
|
||
.DocSearch-Button { | ||
@apply mr-[-18px] !important; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't changed this, Maybe the actual code has changed on GitHub, which I have copied and changed recently between my last clone.
Hi @Achanandhi-M , I removed the changes I made earlier in the JS file section. I am not able to make the changes regarding the formatting of "Start Capturing Section." Although I have fixed the issue that was raised. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please create a fresh PR for this one, with proper code changes and the title and description?
What has changed?
This PR corrects the Markdown formatting in the installation guide (installation_tabs.md), specifically within the Linux, macOS, and Windows sections.
This resolves a rendering bug where
bash
code blocks were not properly indented inside their numbered list items. This lack of indentation caused the Markdown parser to break the list's structure, leading to visual alignment issues. The fix ensures all lists containing code blocks now render correctly with consistent styling.This PR Resolves #3022 (issue raised on keploy/keploy)
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
I have tested these changes by running the development server locally with npm run start and visually confirming that the fix is working as expected.
The numbered list in "Option 1: Install Keploy with Lima" now renders correctly without any alignment or styling issues. I also confirmed the same fix for the Docker installation steps.
As requested, I have also run npm run build and npm run serve to verify the production build.
Before:
(Screenshot of the broken page)

After:
(Screenshot of the fixed page)

Checklist: