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.

Sign up for GitHub

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

Jump to bottom

📝 Clean up the documentation #820

Closed
wants to merge 1 commit into from
Closed

📝 Clean up the documentation #820

wants to merge 1 commit into from

Conversation

Eremiell
Copy link
Contributor

@Eremiell Eremiell commented Aug 29, 2023 •
edited
Loading

  • Resolves bunch of unrelated documentation issues
  • Wrong capitalisation of headers and brands
  • Wrong indentation of code examples
  • Various typos, missing Oxford commas, bad style, or typography
  • Examples didn't follow Style Guidelines in many places
  • Tries to slim down on unneeded newlines
  • Bunch of files have been wrongly named or wrongly placed
  • Attempt to update some outdated details
  • Overall there are other things the would deserve some work but that felt too ambitious for this already huge changeset
  • My pull request is made against the dev branch.
  • I have ensured that the changed library can be built on your target system. I did not introduce any platform-specific code.
  • I have ensured that all methods and functions are fully documented using doxygen style comments.
  • I tested my commits, by adding a test case to the unit tests if needed
  • I have ensured that I did not break any existing API calls.
  • My code follows the coding style guide (if you are not sure, match the code style of existing files including indent style etc).
  • I have not built my pull request using AI, a static analysis tool or similar without any human oversight. Where I have generated this pull request using a tool, I have justified why this is needed.

@CLAassistant
Copy link

CLAassistant commented Aug 29, 2023 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@netlify
Copy link

netlify bot commented Aug 29, 2023 •
edited
Loading

✅ Deploy Preview for dpp-dev ready!

Name Link
🔨 Latest commit 6e4a792
🔍 Latest deploy log https://app.netlify.com/sites/dpp-dev/deploys/64eeb122fa929a0008753952
😎 Deploy Preview https://deploy-preview-820--dpp-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

braindigitalis
braindigitalis reviewed Aug 29, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
Jaskowicz1
Jaskowicz1 reviewed Aug 29, 2023
View reviewed changes
README.md Show resolved Hide resolved
Mishura4
Mishura4 requested changes Aug 29, 2023
View reviewed changes
Copy link
Member

@Mishura4 Mishura4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dialog here is more correct? It's the name for a pop-up window that the user can submit input to. This is how Qt, Windows, and pretty much every UI refers to them

Discord in fact only refers to them as "Modal"

Mishura4
Mishura4 requested changes Aug 29, 2023
View reviewed changes
Copy link
Member

@Mishura4 Mishura4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be really hard to review as a whole due to the size of the changes and I'll expect we'll have to do several passes at it, but here's some things that should be changed.

Please put newlines back at the end of each text file (or add it if it was missing), along with the other requests in this review

docpages/example_programs/music_and_audio/oggopus.md Show resolved Hide resolved
docpages/example_programs/music_and_audio/soundboard.md Show resolved Hide resolved
@braindigitalis
Copy link
Contributor

Dialog here is more correct? It's the name for a pop-up window that the user can submit input to. This is how Qt, Windows, and pretty much every UI refers to them

Discord in fact only refers to them as "Modal"

we should strictly use the term modal and nothing else, as this is what discord api calls them. not dialog, or popup or window or any other term as this will confuse users.

@Eremiell
📝 Clean up the documentation
6e4a792 
* Resolves bunch of unrelated documentation issues
* Wrong capitalisation of headers and brands
* Wrong indentation of code examples
* Various typos, missing Oxford commas, bad style, or typography
* Examples didn't follow Style Guidelines in many places
* Tries to slim down on unneeded newlines
* Bunch of files have been wrongly named or wrongly placed
* Attempt to update some outdated details
* Overall there are other things the would deserve some work but
  that felt too ambitious for this already huge changeset
@Jaskowicz1 Jaskowicz1 mentioned this pull request Sep 1, 2023
Merged
7 tasks
This was referenced Sep 2, 2023
Merged
Closed
@Commandserver Commandserver added the documentation Improvements or additions to documentation label Sep 3, 2023
This was referenced Sep 7, 2023
Merged
Merged
Merged
Merged
braindigitalis pushed a commit that referenced this pull request Sep 14, 2023
@Jaskowicz1 @Eremiell
docs: merged coding_style_standards.md with #820 (#852)
faf4cbc 
Co-authored-by: Jakub 'Eremiell' Marek <[email protected]>
Mishura4 pushed a commit to Mishura4/DPP-PRs that referenced this pull request Sep 17, 2023
@Jaskowicz1 @Eremiell @Mishura4
docs: merged coding_style_standards.md with brainboxdotcc#820 (brainb…
a650ace 
…oxdotcc#852)

Co-authored-by: Jakub 'Eremiell' Marek <[email protected]>
@Jaskowicz1 Jaskowicz1 mentioned this pull request Sep 20, 2023
Merged
4 tasks
braindigitalis pushed a commit that referenced this pull request Sep 21, 2023
@Jaskowicz1 @Eremiell
docs: added more info to the buildcmake page. Merged cmake.md with #820…
206dd77 
…. (#872)

Co-authored-by: Jakub 'Eremiell' Marek <[email protected]>
@Jaskowicz1 Jaskowicz1 mentioned this pull request Sep 21, 2023
Closed
4 tasks
This was referenced Oct 3, 2023
Merged
Merged
braindigitalis pushed a commit that referenced this pull request Oct 3, 2023
@Jaskowicz1 @Eremiell
docs: merged all changes to make_a_bot from #820 (#915)
0dee598 
Co-authored-by: Jakub 'Eremiell' Marek <[email protected]>
@braindigitalis
Copy link
Contributor

this has so many conflicts now as to be unmergable and parts of it have made their way into the docs anyway, should this pr be closed? It could always be reopened in the future.

@Jaskowicz1
Copy link
Contributor

this has so many conflicts now as to be unmergable and parts of it have made their way into the docs anyway, should this pr be closed? It could always be reopened in the future.

I would like to try get some files changed to add parts from this PR, then I'll close it when I'm done :)

Jaskowicz1 added a commit to Jaskowicz1/DPP that referenced this pull request Nov 1, 2023
@Jaskowicz1
docs: added all file changes from brainboxdotcc#820
a22984b
@Jaskowicz1 Jaskowicz1 mentioned this pull request Nov 1, 2023
Merged
4 tasks
@Jaskowicz1
Copy link
Contributor

I am now closing this PR as #990 now adds anything left that hasn't been added from other PRs.

@Jaskowicz1 Jaskowicz1 closed this Nov 1, 2023
braindigitalis added a commit that referenced this pull request Nov 2, 2023
@Jaskowicz1 @braindigitalis
docs: added all file changes from #820 (#990)
223e0a1 
Co-authored-by: Craig Edwards (Brain) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mishura4 Mishura4 Mishura4 requested changes

@braindigitalis braindigitalis braindigitalis left review comments

@Commandserver Commandserver Commandserver left review comments

@Jaskowicz1 Jaskowicz1 Jaskowicz1 left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Eremiell @CLAassistant @braindigitalis @Jaskowicz1 @Mishura4 @Commandserver