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

Doc: Convert known_bugs.txt to markdown format #7788

Closed

Conversation

@andythenorth
Copy link
Contributor

andythenorth commented Oct 20, 2019

Straightforward rename + reformat.

  • both commits are needed to maintain history on the file rename, don't squash on merge
  • I've add GH links to all the bugs that have an issue number provided
  • I've formatted some code blocks, but no guarantee I got them all
  • inbound links to known_bugs.txt will break, one option is to leave a known_bugs.txt in place as a shim, with a note. The other is to update links from website, wiki etc
@LordAro
Copy link
Member

LordAro commented Oct 20, 2019

I'm not a fan of the GH links tbh, they make the file very ugly to read in plain format

@LordAro
Copy link
Member

LordAro commented Nov 27, 2019

Yeah, i've decided that I don't like this doc in markdown format. By all means move it into docs/ folder, but I think it should remain as text

@LordAro
Copy link
Member

LordAro commented Dec 23, 2019

Going to do an andy and arbitrarily close it - I just don't like how the markdown link format hurts readability. Much prefer the plaintext format

@LordAro LordAro closed this Dec 23, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.