-
Notifications
You must be signed in to change notification settings - Fork 25
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
docs: TI review of wiki pages and updates to readme files #56
Conversation
The whole documentation is published on GitHub wiki, for which are the MediaWiki references preferable over markdown references (I am not 100% sure, but I think markdown references required full url to target). |
Relative paths work too in Markdown, but in MW you just need the page title. I am a bit confused then, since the rest of the pages are formatted in markdown, only home.MD is in mediawiki (and the mediawiki links don't show up properly) |
All pages are formatted in markdown, only links between the pages are written using the MediaWiki syntax. I agree it may be a bit messy but at least for me it easy to use (mainly because I do not know MW syntax).
They don't show up properly when viewing the sources directly, but they show up properly in GitHub wiki - that is the target platform. The |
OK, thanks for the explanation, I wasn't aware the GitHub wiki could read both formats at once |
All files in the root folder are now done |
Sure, go ahead with the renaming. I don't see any problems it will cause. |
All pages are done |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you did a great job, thanks. I am sending several suggestions, mostly to get rid of double headings in wiki that I left there.
Co-authored-by: Michal Bali <38988507+michalbali256@users.noreply.github.com>
Co-authored-by: Michal Bali <38988507+michalbali256@users.noreply.github.com>
Co-authored-by: Michal Bali <38988507+michalbali256@users.noreply.github.com>
Co-authored-by: Michal Bali <38988507+michalbali256@users.noreply.github.com>
Co-authored-by: Michal Bali <38988507+michalbali256@users.noreply.github.com>
Co-authored-by: Michal Bali <38988507+michalbali256@users.noreply.github.com>
Thansk! Just FYI, MediaWiki pipe links are [[target|link text]], not [[link text|target]]. I fixed one more. |
Kudos, SonarCloud Quality Gate passed! 0 Bugs |
🎉 This PR is included in version 0.12.0-beta.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
🎉 This PR is included in version 0.12.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Not finished yet, creating this so that I can keep track of work done so far.