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

[BUG] Fix links in Github WIKI #662

Open
5 tasks
dework-integration bot opened this issue Apr 10, 2023 · 0 comments
Open
5 tasks

[BUG] Fix links in Github WIKI #662

dework-integration bot opened this issue Apr 10, 2023 · 0 comments

Comments

@dework-integration
Copy link

dework-integration bot commented Apr 10, 2023

Source: #494

Objective

Fix the relative links in the GitHub Wiki.

The following video shows how clicking internal (not on the sidebar) links in the GitHub wiki points to an empty page.

217116051-794ba687-9ca3-4103-9097-143a3d038ae6.1.mov

Origin Document

The original GitHub wiki issue was tracked in #133 and implemented in #419 but the relative links from the core repo were not overridden.

The current implementation does a copy-pasta of the README files, but does not modify its internal contents. This must be done for relative documentation pages to work.

Goals

  • Allow users to navigate internal links by clicking on them directly in the GitHub Wiki

Deliverable

  • A PR that updates wiki_sync to not only copy over the files (current implementation) but also:
    • Identify all internal links
    • Update all internal links to new GitHub wiki based URL
  • An updated & functional GitHub wiki that does not have the issue shown in the video above

Non-goals / Non-deliverables

  • Updating any existing documentation

Testing Methodology

  • Verify that the new wiki works and show it in action

Creator: @Olshansk
Co-Owners: @profishional

Read more about this task and rewards on Dework.xyz

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

No branches or pull requests

0 participants