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

Feature: Add Wiki section in the extension #816

Merged
merged 54 commits into from
Sep 10, 2024
Merged

Conversation

mohdsayed
Copy link
Collaborator

@mohdsayed mohdsayed commented Aug 23, 2024

Description

Dynamically fetch ps-analysis-tool/wiki and use that in a new Wiki section in PSAT extension.

Relevant Technical Choices

  • Parse sidebar markup for text and create an object for using in React components.
  • Implement resizable and sticky sidebar.
  • Parse markup using marked npm package.
  • Fetch Markdown files based on the selected page.
  • Handle internal images to be fetched from GitHub.
  • Open external links in a new tab.
  • Style markdown github-markdown-css and some custom CSS.
  • Implementation of opening internal links within PSAT.
  • Handle hash for scrolling the given section into view.

Testing Instructions

Additional Information:

Limitations:

  • Internal links open in a new tab.
  • Menu item with ID is not included.

Screenshot/Screencast


Checklist

  • I have thoroughly tested this code to the best of my abilities.
  • I have reviewed the code myself before requesting a review.
  • This code is covered by unit tests to verify that it works as intended.
  • The QA of this PR is done by a member of the QA team (to be checked by QA).

Fixes #820

@mohdsayed mohdsayed self-assigned this Aug 23, 2024
@milindmore22
Copy link
Collaborator

milindmore22 commented Sep 3, 2024

QA The table colors are now white, please make them dark with white text.
image

@milindmore22
Copy link
Collaborator

QA : In Dark mode the code snippets remains dark

image

@pavanpatil1
Copy link
Collaborator

pavanpatil1 commented Sep 4, 2024

  • If the wiki link is included in the extension, it should direct users to the internal wiki rather than to GitHub.
internal.linking.webm

  • After selecting a sub-navigation menu item, the navigation does not appear as active.
active.webm

  • The extra top padding is visible on all headings. It should not be visible, and the icons are not appearing.
Screenshot 2024-09-04 at 9 09 37 AM

@mayan-000 mayan-000 changed the base branch from develop to release/v0.11.0 September 6, 2024 09:48
@pavanpatil1
Copy link
Collaborator

pavanpatil1 commented Sep 9, 2024

Verified the fixes, and they are working fine.

Note: As we discussed, the multi-tab debugging link on the settings page isn't directing to the specific wiki subpage because the content is integrated into the main page, and there isn't a separate subsection for it. This needs to be updated from wiki.

mutitab.webm

@mohdsayed mohdsayed merged commit 0437cb5 into release/v0.11.0 Sep 10, 2024
4 checks passed
@mohdsayed mohdsayed deleted the feat/add-wiki branch September 10, 2024 02:57
@mayan-000 mayan-000 mentioned this pull request Sep 17, 2024
28 tasks
@mohdsayed mohdsayed changed the title Add Wiki section in the extension Feature: Add Wiki section in the extension Sep 18, 2024
@mohdsayed mohdsayed mentioned this pull request Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants