Improve Documentation (issue 2989) #3550
Conversation
spaetz
force-pushed
the
develop
branch
3 times, most recently
from
0d07358 to
7520cfc
Compare
ctsdownloads
added
the
💡 enhancement
|
Dear Team OpenShot, |
|
Not sure why issue 2989 does not show this pull request as related pull request... |
|
Thanks! I'm ashamed to say I haven't had a chance to look at this yet.
To relate PRs to Issues, you need to use one of Github's keywords:
However, as the names imply, adding that kind of linking means that the related issue will auto-close when the PR is merged, which I'm not sure is the desired effect on a non-specific issue regarding something as open-ended as documentation. (There's no way to set up a "non-closing relation" unfortunately, submitters sometimes add notes that a PR "addresses #FOO" or is "related to #BAR" as an intentional way of relating them without setting up an auto-close, since it at least does get a "mentioned" note placed in the issue — as your initial description did, on this one.) |
|
@ferdnyc no need to apologize, no hurry there. As long as you merge it now, of course ;-). |
There was a problem hiding this comment.
@spaetz Finally got a chance to review this, thanks for submitting! (Sorry about the wait, again.) I noted a couple of changes needed (Primarily the image paths, other stuff is at-your-discretion really.)
Also, it's probably a good idea to edit the index.rst file, to insert the installation page into the TOC wherever it should go. (I don't have an immediate answer to that question myself, but point is it's good to tell Sphinx explicitly what order to place the sections in.)
doc/quick_tutorial.rst
Outdated
| @@ -63,7 +73,8 @@ buttons. | |||
|
|
|||
| Step 5 – Export your Video | |||
| --------------------------- | |||
| Once you are happy with your photo slide-show video, the next step is to export your video. | |||
|
|
|||
| Once you are happy with your video, the next step is to export your video. | |||
There was a problem hiding this comment.
Ditto here, re: redundancy. Perhaps "Once you are happy with your layout...", or "Once you are happy with your project..."?
Pfeww, glad this is in my MR then: Will fix the other suggestions, thanks for reviewing. |
This is a smallish attempt to improve openshot's sparse documentation (issue OpenShot#2989). The getting started page only contains an installation description, so name it so. Improve the quick tutorial somewhat (at least according to my taste) but still keep it quick. Improve the start of the "Files" pages somewhat. Make the import files table more consistent by nameing the method in the first column and actually describing them in a full senctence (interpunction) in the 2nd column. Add the actual toolbar button icon image to the table. Similar things for the slice clips table on the clips page.
|
Once this get through Travis, I'll merge. Many thanks, @spaetz ! |
This is a smallish attempt to improve openshot's sparse documentation
(issue #2989).
The getting started page only contains an installation description, so name
it so. Improve the quick tutorial somewhat (at least according to my taste)
but still keep it quick. Improve the start of the "Files" pages somewhat.
Make the import files table more consistent by nameing the method in the
first column and actually describing them in a full senctence (interpunction)
in the 2nd column. Add the actual toolbar button icon image to the table.
Far more is needed, but this is my first take at something easy.