[Improve] Added Table of Contents and FAQs to README #5693
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adarsh-jha-dev
changed the title
adarsh-jha-dev
changed the title
Hisoka-X
changed the title
Hisoka-X
changed the title
|
Thanks @adarsh-jha-dev , Could you fix the CI error? |
yeah sure, on it |
Hey @Hisoka-X , I have resolved that CI error, you may proceed further. |
|
cc @EricJoy2048 |
|
Could you rebase on dev? We add a new part for SeaTunnel web project. |
it is already having the base branch : dev, do i need to change that? If yes, then to which branch? |
|
rebase on dev so you can resolve conflict. (Or merge from dev). |
Done, you may proceed further |
Hisoka-X
reviewed
Oct 25, 2023
|
@EricJoy2048 @ic4y @hailin0 @ruanwenjun Are you ok with this change? |
EricJoy2048
previously approved these changes
Oct 26, 2023
Hisoka-X
reviewed
Oct 26, 2023
Co-authored-by: Jia Fan <fanjiaeminem@qq.com>
Hisoka-X
approved these changes
Oct 27, 2023
hailin0
approved these changes
Oct 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
This pull request adds a Table of Contents (TOC) and a Frequently Asked Questions (FAQs) section to the README for better user experience and documentation organization.
Does this PR introduce any user-facing change?
No, this PR doesn't introduce any user-facing changes. It's a documentation improvement for better readability and accessibility.
How was this patch tested?
This change was tested by verifying that the documentation renders correctly with the added TOC and FAQs. Manual testing was performed to ensure the TOC links work as expected, providing easy navigation through the document.
Checklist
release-note.