Skip to content

Change some definitionlist to subsubsection for better layout; Add forum to subsection For more information #6965

Closed
prko wants to merge 1 commit intosupercollider:developfrom
prko:topic/more_words_to_help_home
Closed

Change some definitionlist to subsubsection for better layout; Add forum to subsection For more information #6965
prko wants to merge 1 commit intosupercollider:developfrom
prko:topic/more_words_to_help_home

Conversation

@prko
Copy link
Contributor

@prko prko commented Jun 10, 2025

Purpose and Motivation

Yesterday, I accessed http://doc.sccode.org on my Android smartphone and realised the layout of the last three subsections are a bit ugly:
This PR amends some definition lists to subsections to align with the layout of the documentation.

  • Before this PR:
    Screenshot 2025-06-10 at 15 16 18
  • With this PR
    Screenshot 2025-06-11 at 00 56 34

Types of changes

  • Bug fix

To-do list

  • Code is tested
  • All tests are passing
  • Updated documentation
  • This PR is ready for review

@capital-G
Copy link
Contributor

capital-G commented Jun 10, 2025

Thanks for spotting and fixing this @prko!

In order to make this the cut to 3.14 you need a bit of a different procedure though.

Create a new branch based on the branch 3.14 (instead of develop), apply and commit the changes and perform a PR with said branch not against develop but against 3.14.
The 3.14 branch will be also merged into to develop, so those changes will also arrive at develop at some point.

edit and OT: I just figured out that doc.sccode.org has been updated to 3.14-dev - I'd actually prefer if doc.sccode.org could instead phase out / redirect to the official docs @ docs.supercollider.online / https://github.com/supercollider/sc-docs b/c it is always unclear to me who is responsible for this website and the official docs provide some nice hacks (e.g. link to github sources). IIRC this was outdated and is now e.g. missing the 3.14 changelog which the official docs offers => https://docs.supercollider.online/Guides/News-3_14.html

@HotwheelsSisyphus HotwheelsSisyphus added the comp: help schelp documentation label Jun 10, 2025
@prko
Copy link
Contributor Author

prko commented Jun 10, 2025

@capital-G
I opened #6968. Did I do it correctly? In that commit, #6963 is included....?

@capital-G
Copy link
Contributor

@capital-G I opened #6968. Did I do it correctly? In that commit, #6963 is included....?

Almost ;) During PR creation you have to specify the branch you want to target - by default it is develop but in this case it is the 3.14 branch.

grafik

I changed this now to 3.14.

Closing this PR in favor of #6968

@capital-G capital-G closed this Jun 10, 2025
@prko
Copy link
Contributor Author

prko commented Jun 10, 2025

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp: help schelp documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants