-
Notifications
You must be signed in to change notification settings - Fork 24
Improve and consolidate Sugar Activities documentation #41
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
base: main
Are you sure you want to change the base?
Conversation
|
Hey @quozl, I’ve added examples from the official FLOSS Manuals and filled in some missing content. Please have a look when you get a chance. |
|
How come there are scripts to generate documentation, but the documentation that's supposed to be generated is missing? Also take a look at the issue and the conversation there, you've referenced it but your PR suggests that you haven't looked at it as you've replicated something similar to an earlier attempt. |
|
Please stick to one pull request; there's no reason to keep opening new ones, to update a pull request all you have to do is to reset your branch and force push. Discussion on this has been scattered across three pull requests so far. This makes it very hard for reviewers. You want it to be hard? I see the documentation in this pull request, but I also see scripts that you had decided not to include (in #39). |
|
@quozl @chimosky Thanks for the feedback — I’ve consolidated everything into this single PR now. This PR:
No runtime logic was changed beyond registering the new doc. Round three , fully consolidated this time 😄 |
|
Thanks. I've checked code examples are present, and the scripts are not. Aggregate change includes a blank line added to requirements.txt, please don't make unnecessary changes. Please squash your four commits into one. Please also make sure your commit message follows Contributing - Making Commits, as at the moment the commit messages are one liners. |
dfab801 to
8d64dea
Compare
Add the consolidated Sugar Activities guide from FLOSS Manuals (https://archive.flossmanuals.net/make-your-own-sugar-activities/) and register it in the documentation configuration. The content is included as-is; no content was changed or rewritten. No runtime logic changes.
8d64dea to
189efeb
Compare
|
Thanks for the review! |
|
GitHub warns me that requirements.txt now lacks a trailing newline. You could have caught this by looking at the changes in your commit. |
|
Thanks for the catch, I’ve added the trailing newline to requirements.txt and pushed the fix. |
This PR finalizes and cleans up the Sugar Activities: Complete Guide documentation by consolidating and normalizing the content into a single, well-structured Markdown document.
Changes included:
Consolidated the full “Make Your Own Sugar Activities” guide into docs/Sugar_Activities.md
Removed UI artifacts and copy-paste noise from the original source
Normalized Markdown structure (headings, code blocks, spacing)
Preserved all original content exactly (no technical or textual changes)
Ensured long code examples remain intact and unmodified
issue:#21