-
-
Notifications
You must be signed in to change notification settings - Fork 121
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
improved FAQ description text #709
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.
Here pls. add one more sentence in this paragraph since there's a bug related to faq page width which is fixed by width of two-liner paragraph.
Alright, I'll update this. |
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.
The description looks good, however to close this issue we need to review the wording and completeness of each question and answer.
The data fetched for the questions is available in the file:
/data/faq.json
Noted, thank you. |
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.
Great work Blessing!! I just left some suggestions.
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com>
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.
Great work!
* Standardize List Display with Card Component (#433) (#460) * Standardize List Display with Card Component (#433) * Addressed comments, added images, and implemented new styles * Increased padding on the x-axis * feat: added Faq section (#534) * Fix faq * Added Case Studies page in Overview Section (#473) * updated UI of blog-page * Added Case Studies Page * fixed linting errors * Added casestudies * changing index.page.tsx * Delete components/CustomComponent.tsx * Delete pages/overview/casestudies.md * removed unnecessary changes * removed unnecessary files * fixed bug * removed changes * removed unnecessary files * Pushing last changes. --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * feat: added resource section (#509) * fixed * feat: added resource section * feat: added resource section * revert changes cd6d848 * revert changes 65e9f3e * revert changes 877b0f0 * revert changes 74711cd * fix: fixed the width issue * revert change * fix: added resource icon * Tiny changes to adjust look and feel. * Last changes to fix dark theme --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Feat: Add the Newsletter feature to the website. (#489) * initialize the Test directory. * Added the subscribe button. * Added the subscribe page. * Added the newsletter page. * changed name to newsletter. * removed the unwated code. * removed the unwated components. * decreased the horizontal width and changed the color. * decreased the font size. * Added the changes for the newsletter banner. * Added the newletter component to landing page. * added the color for input. * Added the required horizontal padding. * Added the required horizontal padding. for newsletter page. * Add changes to make it work with mailchimp * added the yarn file back. * Added yarn.lock file. * Update yarn.lock * linted the newsletter.tsx * linted newsletter * fix the index.page * Small improvement in page layout. * Fix dark theme behavior * . --------- Co-authored-by: AyushNautiyalDeveloper <ayush@betalectic.com> Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Added welcome page (#566) * added welcome page * Pushed some changes to changes - Better location in sidebar - Changes to move what is json schema into getting started - move page inside overview --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Added Use-cases page (#589) * added use-cases page, modified card component * fix * Added some changes to better merge with the dev branch. --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Change docs link * fix: spacing between buttons (#575) * docs: added definition of json hyper-schema * fixed * fix: spacing b/w buttons * fix: added spacing in mobile design * fix: spacing on tablet screen * fix: spacing on less than 300px screen * community-page (#646) * community-page * Some final changes for the community page --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Update Sidebar.tsx * Add resources file * Update Sidebar.tsx * Update case-studies.json * Text colours for dark theme * New version of the implementers page * Feat: Replacing Axios to fs fetching in resources page (#657) * cleaning * changing axios to fs * Remove articles from sidebar --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Improve Case Studies and Use Cases welcome messages * adding codeowners * Fixing bugs and adding back lost files * fix sidebar dropdown for FAQ * community page major changes and faq bug fix * community page bug fixes and responsive issues in several pages * Update index.page.tsx (#684) * Update index.page.tsx Edited the placeholder texts for the welcome page. * fixed lint error * Edited wordings for the Welcome page of release 3 * Update pages/overview/welcome/index.page.tsx Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Update pages/overview/welcome/index.page.tsx Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Remove data duplication and fix intro text --------- Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Feat: Removing resources and newletter from web-release-3 branch (#698) * removing newsletter * removing resources * removing resources.yml file * removing resources from welcomee page --------- Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * case-studies bug fix and hover delay fix * adding ts comment * Small corrections * Update blogs link * Ambassadors button aligned to the left * Feat: Fixing responsive bugs from community page * community page bug fixes * Added uses cases texts * Last changes to use-cases * Add html to the use cases definition * feat:adding html parser for use-cases page * removing links from images * improved FAQ description text (#709) * improved FAQ description text * Updated FAQ general questions * Updated FAQ description text for fix one-sentence bug * Update data/faq.json Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Update data/faq.json Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Update data/faq.json Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Update pages/overview/faq/index.page.tsx --------- Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Improvement for case studies * merge confilts * removing merge conflicts * Fix:community card gap * Align with main branch * Align with main branch * Align with main branch * Update pages/overview/what-is-jsonschema.md Co-authored-by: Ben Hutton <relequestual@gmail.com> * Remove welcome data file * Move welcome outside overview section * Change welcome text * Feat: Replaced axios with fetch * moved path to function * Updating community filters * Update pages/community/index.page.tsx Co-authored-by: Ben Hutton <relequestual@gmail.com> * Fix the menu links * Update the JSON Schema calendar link * Change ambassadors image --------- Co-authored-by: Michael Obubelebra Amachree <amachree9630@gmail.com> Co-authored-by: Akshay Bagai <100753870+Akshaybagai52@users.noreply.github.com> Co-authored-by: Tamanna <96949249+TamannaVerma99@users.noreply.github.com> Co-authored-by: Ayush Nautiyal <78146753+ayushnau@users.noreply.github.com> Co-authored-by: AyushNautiyalDeveloper <ayush@betalectic.com> Co-authored-by: VivekJaiswal18 <96608169+VivekJaiswal18@users.noreply.github.com> Co-authored-by: Neeraj Saini <118799941+officeneerajsaini@users.noreply.github.com> Co-authored-by: Dhairya Majmudar <124715224+DhairyaMajmudar@users.noreply.github.com> Co-authored-by: Dhairya Majmudar <2022kuec2045@iiitkota.ac.in> Co-authored-by: Blessing Ene Anyebe <60541622+kwennB@users.noreply.github.com> Co-authored-by: Ben Hutton <relequestual@gmail.com>
* chore(deps): bump eslint-plugin-react from 7.33.2 to 7.35.0 (#813) Bumps [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) from 7.33.2 to 7.35.0. - [Release notes](https://github.com/jsx-eslint/eslint-plugin-react/releases) - [Changelog](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/CHANGELOG.md) - [Commits](jsx-eslint/eslint-plugin-react@v7.33.2...v7.35.0) --- updated-dependencies: - dependency-name: eslint-plugin-react dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump Renato66/auto-label from 3.0.0 to 3.1.0 (#809) Bumps [Renato66/auto-label](https://github.com/renato66/auto-label) from 3.0.0 to 3.1.0. - [Release notes](https://github.com/renato66/auto-label/releases) - [Commits](Renato66/auto-label@v3.0.0...v3.1.0) --- updated-dependencies: - dependency-name: Renato66/auto-label dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump eslint-plugin-n from 16.3.1 to 16.6.2 (#810) Bumps [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n) from 16.3.1 to 16.6.2. - [Release notes](https://github.com/eslint-community/eslint-plugin-n/releases) - [Changelog](https://github.com/eslint-community/eslint-plugin-n/blob/master/CHANGELOG.md) - [Commits](eslint-community/eslint-plugin-n@16.3.1...16.6.2) --- updated-dependencies: - dependency-name: eslint-plugin-n dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump @types/react-syntax-highlighter (#812) Bumps [@types/react-syntax-highlighter](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/react-syntax-highlighter) from 15.5.10 to 15.5.13. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/react-syntax-highlighter) --- updated-dependencies: - dependency-name: "@types/react-syntax-highlighter" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(deps): bump @docsearch/react from 3.5.2 to 3.6.1 (#811) Bumps [@docsearch/react](https://github.com/algolia/docsearch) from 3.5.2 to 3.6.1. - [Release notes](https://github.com/algolia/docsearch/releases) - [Changelog](https://github.com/algolia/docsearch/blob/main/CHANGELOG.md) - [Commits](algolia/docsearch@v3.5.2...v3.6.1) --- updated-dependencies: - dependency-name: "@docsearch/react" dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Web release 3 (#655) * Standardize List Display with Card Component (#433) (#460) * Standardize List Display with Card Component (#433) * Addressed comments, added images, and implemented new styles * Increased padding on the x-axis * feat: added Faq section (#534) * Fix faq * Added Case Studies page in Overview Section (#473) * updated UI of blog-page * Added Case Studies Page * fixed linting errors * Added casestudies * changing index.page.tsx * Delete components/CustomComponent.tsx * Delete pages/overview/casestudies.md * removed unnecessary changes * removed unnecessary files * fixed bug * removed changes * removed unnecessary files * Pushing last changes. --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * feat: added resource section (#509) * fixed * feat: added resource section * feat: added resource section * revert changes cd6d848 * revert changes 65e9f3e * revert changes 877b0f0 * revert changes 74711cd * fix: fixed the width issue * revert change * fix: added resource icon * Tiny changes to adjust look and feel. * Last changes to fix dark theme --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Feat: Add the Newsletter feature to the website. (#489) * initialize the Test directory. * Added the subscribe button. * Added the subscribe page. * Added the newsletter page. * changed name to newsletter. * removed the unwated code. * removed the unwated components. * decreased the horizontal width and changed the color. * decreased the font size. * Added the changes for the newsletter banner. * Added the newletter component to landing page. * added the color for input. * Added the required horizontal padding. * Added the required horizontal padding. for newsletter page. * Add changes to make it work with mailchimp * added the yarn file back. * Added yarn.lock file. * Update yarn.lock * linted the newsletter.tsx * linted newsletter * fix the index.page * Small improvement in page layout. * Fix dark theme behavior * . --------- Co-authored-by: AyushNautiyalDeveloper <ayush@betalectic.com> Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Added welcome page (#566) * added welcome page * Pushed some changes to changes - Better location in sidebar - Changes to move what is json schema into getting started - move page inside overview --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Added Use-cases page (#589) * added use-cases page, modified card component * fix * Added some changes to better merge with the dev branch. --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Change docs link * fix: spacing between buttons (#575) * docs: added definition of json hyper-schema * fixed * fix: spacing b/w buttons * fix: added spacing in mobile design * fix: spacing on tablet screen * fix: spacing on less than 300px screen * community-page (#646) * community-page * Some final changes for the community page --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Update Sidebar.tsx * Add resources file * Update Sidebar.tsx * Update case-studies.json * Text colours for dark theme * New version of the implementers page * Feat: Replacing Axios to fs fetching in resources page (#657) * cleaning * changing axios to fs * Remove articles from sidebar --------- Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Improve Case Studies and Use Cases welcome messages * adding codeowners * Fixing bugs and adding back lost files * fix sidebar dropdown for FAQ * community page major changes and faq bug fix * community page bug fixes and responsive issues in several pages * Update index.page.tsx (#684) * Update index.page.tsx Edited the placeholder texts for the welcome page. * fixed lint error * Edited wordings for the Welcome page of release 3 * Update pages/overview/welcome/index.page.tsx Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Update pages/overview/welcome/index.page.tsx Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Remove data duplication and fix intro text --------- Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> Co-authored-by: Benjamin Granados <benjamin.granadosm@gmail.com> * Feat: Removing resources and newletter from web-release-3 branch (#698) * removing newsletter * removing resources * removing resources.yml file * removing resources from welcomee page --------- Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * case-studies bug fix and hover delay fix * adding ts comment * Small corrections * Update blogs link * Ambassadors button aligned to the left * Feat: Fixing responsive bugs from community page * community page bug fixes * Added uses cases texts * Last changes to use-cases * Add html to the use cases definition * feat:adding html parser for use-cases page * removing links from images * improved FAQ description text (#709) * improved FAQ description text * Updated FAQ general questions * Updated FAQ description text for fix one-sentence bug * Update data/faq.json Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Update data/faq.json Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Update data/faq.json Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Update pages/overview/faq/index.page.tsx --------- Co-authored-by: Benjamin Granados <40007659+benjagm@users.noreply.github.com> * Improvement for case studies * merge confilts * removing merge conflicts * Fix:community card gap * Align with main branch * Align with main branch * Align with main branch * Update pages/overview/what-is-jsonschema.md Co-authored-by: Ben Hutton <relequestual@gmail.com> * Remove welcome data file * Move welcome outside overview section * Change welcome text * Feat: Replaced axios with fetch * moved path to function * Updating community filters * Update pages/community/index.page.tsx Co-authored-by: Ben Hutton <relequestual@gmail.com> * Fix the menu links * Update the JSON Schema calendar link * Change ambassadors image --------- Co-authored-by: Michael Obubelebra Amachree <amachree9630@gmail.com> Co-authored-by: Akshay Bagai <100753870+Akshaybagai52@users.noreply.github.com> Co-authored-by: Tamanna <96949249+TamannaVerma99@users.noreply.github.com> Co-authored-by: Ayush Nautiyal <78146753+ayushnau@users.noreply.github.com> Co-authored-by: AyushNautiyalDeveloper <ayush@betalectic.com> Co-authored-by: VivekJaiswal18 <96608169+VivekJaiswal18@users.noreply.github.com> Co-authored-by: Neeraj Saini <118799941+officeneerajsaini@users.noreply.github.com> Co-authored-by: Dhairya Majmudar <124715224+DhairyaMajmudar@users.noreply.github.com> Co-authored-by: Dhairya Majmudar <2022kuec2045@iiitkota.ac.in> Co-authored-by: Blessing Ene Anyebe <60541622+kwennB@users.noreply.github.com> Co-authored-by: Ben Hutton <relequestual@gmail.com> * Add docs help component (#820) * Feat: Refactoring toc styles (#796) * refactoring toc * updating es * adding heading * adding heading * New slack redirect --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Michael Obubelebra Amachree <amachree9630@gmail.com> Co-authored-by: Akshay Bagai <100753870+Akshaybagai52@users.noreply.github.com> Co-authored-by: Tamanna <96949249+TamannaVerma99@users.noreply.github.com> Co-authored-by: Ayush Nautiyal <78146753+ayushnau@users.noreply.github.com> Co-authored-by: AyushNautiyalDeveloper <ayush@betalectic.com> Co-authored-by: VivekJaiswal18 <96608169+VivekJaiswal18@users.noreply.github.com> Co-authored-by: Neeraj Saini <118799941+officeneerajsaini@users.noreply.github.com> Co-authored-by: Dhairya Majmudar <124715224+DhairyaMajmudar@users.noreply.github.com> Co-authored-by: Dhairya Majmudar <2022kuec2045@iiitkota.ac.in> Co-authored-by: Blessing Ene Anyebe <60541622+kwennB@users.noreply.github.com> Co-authored-by: Ben Hutton <relequestual@gmail.com>
What kind of change does this PR introduce?
Documentation Enhancement
Issue Number:
Closes [📝 Docs]: Review the content of the FAQ page of the release 3 #706
Others?
I also reviewed the general question texts, which are properly formatted and good to go.
Does this PR introduce a breaking change?
No