update readme #3
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,13 +4,13 @@ This git repo contains the manual for Audacity | |||||
| ## Flow of Content | ||||||
|
|
||||||
| * We write the Audacity Manual at https://alphamanual.audacityteam.org | ||||||
| * We get it and mangle it a little using our script, https://github.com/audacity/audacity/blob/master/scripts/mw2html_audacity/mw2html.py | ||||||
| * That content is then pushed as a commit to the GitHub repo. | ||||||
| * A script on our server detects the change at GitHub and pulls the changes to serve them. | ||||||
|
|
||||||
| ## Wiki Tricks | ||||||
|
|
||||||
| There is a lot of content in our manual which would be prohibitively time consuming to produce without automated tools to help us. This is particularly so of the many image maps in the manual. | ||||||
|
|
||||||
| * Most of our tricks are documented at https://wiki.audacityteam.org/wiki/Magicke_Spells | ||||||
|
There was a problem hiding this comment. [Nitpick/proofreading] see line 16 for context.
Suggested change
|
||||||
| * The heavy lifting is done by our 'What Is That' page https://wiki.audacityteam.org/wiki/Using_WIT | ||||||
|
There was a problem hiding this comment. [Nitpick/Proofreading] I think hyperlinking the page’s title would make it quicker for users to access the content. Consider doing that for line 15.
Suggested change
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
[Nitpick/Proofreading/Question] I’m having trouble understanding what “mangle” means @Rajeta-Sarkar. Does it mean fix?
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.
"wget" refers to: https://www.gnu.org/software/wget/
"Mangled" means that it is pulled around / modified. In British English the term is used, slightly humorously, to describe something being reshaped in an inelegant manner.