Skip to content
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

Implement searching documentation files #208

Merged
merged 12 commits into from Jul 22, 2022
Merged

Implement searching documentation files #208

merged 12 commits into from Jul 22, 2022

Conversation

joulev
Copy link
Owner

@joulev joulev commented Jul 20, 2022

There is a search bar in documentation pages. This branch will try to implement it.

Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
Will need testing. A lot of it.

Also since I will try to integrate this to the frontend, depending on
whether the integration part is easy I may have to change the design of
this route.

Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
@joulev joulev added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 20, 2022
@joulev joulev self-assigned this Jul 20, 2022
@codecov
Copy link

codecov bot commented Jul 20, 2022

Codecov Report

Merging #208 (95c981e) into documentation (ed80e06) will decrease coverage by 0.85%.
The diff coverage is 100.00%.

Impacted file tree graph

@@                Coverage Diff                @@
##           documentation     #208      +/-   ##
=================================================
- Coverage          96.49%   95.63%   -0.86%     
=================================================
  Files                 38       39       +1     
  Lines                884      871      -13     
  Branches             180      179       -1     
=================================================
- Hits                 853      833      -20     
- Misses                28       34       +6     
- Partials               3        4       +1     
Impacted Files Coverage Δ
client/components/docs/navbar.tsx 100.00% <100.00%> (ø)
client/components/docs/sidebarlink.tsx 100.00% <100.00%> (ø)
client/lib/docsSearch.ts 100.00% <100.00%> (ø)
client/lib/documentation.ts 100.00% <100.00%> (ø)
server/utils/crud/commentUtils.ts 85.36% <0.00%> (-13.42%) ⬇️
server/utils/crud/pageUtils.ts 98.76% <0.00%> (+2.76%) ⬆️

Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
@joulev
Copy link
Owner Author

joulev commented Jul 21, 2022

  1. Note that this PR will merge to documentation and not to main since in main we don't have much documentation to search yet.
  2. If you feel like doing so, you can transfer this to server (since this is executed on the server, after all), and/or reimplement/modify it to make it more efficient/...

Signed-off-by: Vu Van Dung <joulev.vvd@yahoo.com>
@joulev joulev merged commit 028a926 into documentation Jul 22, 2022
@joulev joulev deleted the doc-search branch July 22, 2022 01:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

1 participant