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 #494

Open
5 tasks
Olshansk opened this issue Feb 7, 2023 · 13 comments
Open
5 tasks

[BUG] Fix links in Github WIKI #494

Olshansk opened this issue Feb 7, 2023 · 13 comments
Labels
bug Something isn't working - expected behaviour is incorrect community Open to or owned by a non-core team member documentation Improvements or additions to documentation

Comments

@Olshansk
Copy link
Member

Olshansk commented Feb 7, 2023

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.

Screen.Recording.2023-02-06.at.4.13.07.PM.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

@Olshansk Olshansk added bug Something isn't working - expected behaviour is incorrect documentation Improvements or additions to documentation community Open to or owned by a non-core team member labels Feb 7, 2023
@Olshansk
Copy link
Member Author

@profishional Should we asign this to you? I wanted to confirm if you plan on working on this or not?

@profishional
Copy link
Contributor

yeah Ill have a go.

@profishional
Copy link
Contributor

I will get to this, just a lot going on. Sorry.

@Olshansk
Copy link
Member Author

I will get to this, just a lot going on. Sorry.

Sg, thank you for the update

@Olshansk
Copy link
Member Author

@profishional We might have another external contributor who could pick this up, so I wanted to know if you were still interested in owning it?

@profishional
Copy link
Contributor

Hi yes, I think thats better.
I've been pulled by another project so really don't think ill be able to do this! Sorry, totally slipped my mind

@Olshansk
Copy link
Member Author

Thanks for letting us know!

cc @jessicadaugherty. I think this is a good starter task we can can save for a new external contributor

@Olshansk
Copy link
Member Author

@smartcontrart Let us know if you're still working on this

@3scava1i3r
Copy link

@Olshansk Interested

@Olshansk
Copy link
Member Author

@Olshansk Interested

Awesome! I think this is a great starter task that's very valuable for the community.

Make sure to request this on https://app.dework.xyz/ and @b3nnnp should be able to help out w.r.t ownership of the bounty and payments.

Otherwise, send over the PR once you have it and the team will provide feedback. Ty!

@3scava1i3r
Copy link

@Olshansk I'm writing to inquire about contacting you over Discord. I have a few questions about the issues assigned to me

@Olshansk
Copy link
Member Author

@Olshansk I'm writing to inquire about contacting you over Discord. I have a few questions about the issues assigned to me

Can you the core-dev-chat in our public discord? https://discord.com/channels/553741558869131266/986789914379186226

@3scava1i3r
Copy link

3scava1i3r commented Jun 21, 2023

@Olshansk I'm writing to inquire about contacting you over Discord. I have a few questions about the issues assigned to me

Can you the core-dev-chat in our public discord? https://discord.com/channels/553741558869131266/986789914379186226

no reference thread found for this issue,also i donot have permission to talk there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working - expected behaviour is incorrect community Open to or owned by a non-core team member documentation Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

3 participants