[CDX-257] Publish revamped docs #238
Merged
Conversation
This file contains hidden or 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
* Add Library overview and installation and quick guide * update title * update styles * update styles * updates * updates * Edit gif height * remove yarn * remove yarn * update * Update README Co-authored-by: Ahmad Mudaafi' <ahmad.mudaafi@constructor.io> Co-authored-by: Viktor Zavala <zavala.viktor@gmail.com> * Address comments --------- Co-authored-by: Ahmad Mudaafi' <ahmad.mudaafi@constructor.io> Co-authored-by: Viktor Zavala <zavala.viktor@gmail.com>
* Add Advanced Features * Add code examples section to readme (#209) * Add code examples section to readme * Update README.md Co-authored-by: Enes Kutay SEZEN <eneskutaysezen@gmail.com> * Update README.md Co-authored-by: Enes Kutay SEZEN <eneskutaysezen@gmail.com> --------- Co-authored-by: Enes Kutay SEZEN <eneskutaysezen@gmail.com> --------- Co-authored-by: Enes Kutay SEZEN <eneskutaysezen@gmail.com>
* add license * lint
* add troubleshooting section * left align text in tables * use html instead of markdown to render table * Update discussions link
* Update integration modes * upload gif to repo --------- Co-authored-by: stanlp1 <stanley.peng@constructor.io>
* [CI-4259] Add customization section to readme * [CI-4259] Summarize and shorten descriptions --------- Co-authored-by: Viktor Zavala <viktor.zavala@constructor.io>
* add doctoc automation * Sets pre_push script to be git executable * Update pre_push hook to exclude changes made by doctoc * test pre_push hook * test: edits to doctoc section * test2: edits to doctoc section * update pre_push hook * update readme * update doctoc configs * lint * update pre-push hook to append a new commit instead of ammend * testing pre_push hook flow * revert back to amend * Test the hook * Test * testing * Test Removing section * a * b * c * Add thing * Add new topic * Revert "revert back to amend" This reverts commit e56366d. * Reapply "revert back to amend" This reverts commit 46be0f7. * Update readme * Change pre-push to pre-commit * base case * move to post-commit * fix post-commit script * Test: README Change outside TOC * docs: auto-update README TOC (post-commit) * fix post-commit script * test: local TOC change * test: addition outside TOC * docs: auto-update README TOC (post-commit) * test: removal outside TOC, TOC updated * run doctoc --------- Co-authored-by: Enes Kutay SEZEN <eneskutaysezen@gmail.com> Co-authored-by: mocca102 <islaam.agamy@gmail.com>
* copy commits * match comments * display props page * update test
* add peer dependencies to troubleshooting.md * lint * transform mardown links to html anchors * code block
# Conflicts: # package-lock.json # src/stories/tests/HooksTests.stories.tsx
Mudaafi
approved these changes
Oct 21, 2025
Contributor
Mudaafi
left a comment
Mudaafi
left a comment
There was a problem hiding this comment.
nice, excited to get this out. First of many 🤞
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.
No description provided.