ossia/score-docs

Note: to edit locally:

$ bundle exec jekyll serve  --config _config.yml,_local_config.yml

Just the Docs

A modern, highly customizable, and responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub Pages with few dependencies.

See it in action!

Installation

Add this line to your Jekyll site's Gemfile:

gem "just-the-docs"

And add this line to your Jekyll site's _config.yml:

theme: just-the-docs

And then execute:

$ bundle

Or install it yourself as:

$ gem install just-the-docs

Alternatively, you can run it inside Docker while developing your site

$ docker-compose up

Usage

View the documentation for usage information.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Submitting code changes:

• Open a Pull Request
• Ensure all CI tests pass
• Await code review
• Bump the version number in just-the-docs.gemspec and package.json according to semantic versioning.

Design and development principles of this theme:

1. As few dependencies as possible
2. No build script needed
3. First class mobile experience
4. Make the content shine

Development

To set up your environment to develop this theme, run bundle install.

Your theme is set up just like a normal Jekyll site! To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

When the theme is released, only the files in _layouts, _includes, and _sass tracked with Git will be released.

License

The theme is available as open source under the terms of the MIT License.

score-docs's Issues

Document config files

And how to reset them

Small images are scaled up

It seems images smaller than page width are scaled up to page width. It would be nice if smaller images were not scaled up (only images bigger than page width get scaled down)

A control surface example

Idea: add an OSC device, map it to a control surface and use the device in other parts of the score: now with the remote app, it's possible to eaisly control specific parts of the score in the timeline !

Need custom style for items from score GUI

At the moment, inline code style is used for styling elements from score UI (buttons names, window section etc.). This is not so much sexy and maybe not obvious.

It could be nice and useful that these UI elements are styled in a specific way.

Documentation does not explain underlying structural model, makes program more difficult to understand

The hierarchy / relationship between states, syncs, events, conditions, triggers, intervals, processes, etc. is not explained anywhere in the documentation. Having just been given an explanation from Pia, I find that knowing the underlying model makes many aspects of the program much easier to understand, whereas before I found it quite opaque how these objects relate to each other, which owns what, or even the purpose of certain UI elements such as the "put in new event" and "desynchronize" buttons in the inspector for a state.

It would be great to have an explanation of these concepts somewhere in the documentation (e.g. as a new "In Depth" page), as it makes certain things much more obvious.

[doc] add play from here ad in last of the first steps

like, just before Summary

with a little gif (showing some sliders, so we instantly get the effect), that would fab!

Document that it is possible to drag'n'drop a port in a scenario or interval

macOS: document the procedure for allowing the OS to move the cursor

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Github error message when pushing

It seems pushing to the repo causes a Github error message. From what I get this is related to some checking job that fail but no idea exactly what...

It seems harmless as things are properly pushed to the repository and published but maybe worth checking...

màj du dossier examples score

ranger, trier, virer les outdateds, et éventuellement en rajouter de nouveaux
-> mettre des examples utilisés dans la doc ?

rajouter des fichiers de namespace ?

[doc] wilcards could be added to the doc

eg in https://ossia.github.io/score/in_depth/value_addressing/index.html

@jcelerier advertised recently that it's supposed to be available everywhere - I guess with ossia.remote syntax...

[RGAA] Too low contrasts in research bar

The contrast is way too low in the search bar.

Contrast of the user's input

Contrast of result's subtitles

We can find the same issue on the mobile phone version.
This is below the RGAA treshold of 4.5 (RGAA critère 3.2 https://accessibilite.numerique.gouv.fr/methode/criteres-et-tests/#3)

To fix : rework the color palette for this part.

Documentation translations

People have started asking for this, at least in french ; japanese would also be nice

Document that it is possible to drop a .score in a scenario & interval

No documentation for package manager

Overview score doesn't seem to work with latest version

As reported in http://forum.ossia.io/t/cant-find-the-overview-directory-mentioned-in-first-steps-tutorial/131/3

Maybe we just need to change the extension to just .score?

Process > Animations > Animation (float)

Hi

the documentation https://ossia.github.io/score/first_steps/first_scenario/index.html shows for
Process > Animations > Animation (float) the ability to choose a noise - curve, but there is no such thing in score 2.2.1.

macOS: document launchign multiple score instances

documentation - files missing for "Writing your first Score scenario"

missing:

• fm-osc-example.device
• Pd version of the patch
• Max version of the patch

thanks!

document skin names

currently the skin color are named 'Base3', "Pulse1' and so on... which is not so descriptive.

it could be nice to give the user some sense of where they are used.

IMHO the best place for that would be in the theme editor, e.g. by adding a second column to the color list, with every place (or at least some places) where this color is used
(I guess this could be implemented by filling some kind of multimap or something every time a Scenario object is given a color so that there's a way to retrieve where each of them is used - am I being clear ?)

Document support for loading OSC devices from TouchOSC

Explain why contents (child scenario, etc) must have different duration than their parent

Make the search UI more visible

Indicate keyboard shortcut for putting things in parallel / in series

If dropping multiple sound files, midi files, etc...
it's possible to chose whether they will be played in parallel or in series, by pressing shift key:

Interoperability

Make demos with a corresponding article for :

• Max without Jamoma
• Max with Jamoma
• PureData
• Unity3D
• Processing
• SuperCollider
• OpenFrameworks
• Cinder
• Some OSC-only fixed software or hardware ?

Document sending a single (or a bundle of osc messages) via a trigger

like that
https://user-images.githubusercontent.com/2772730/119869052-18270080-bf20-11eb-83ba-5718a42f7471.mp4

Document the metadata on objects

e.g. explain why there is a name and a label, why both are necessary, etc.

Document the protocols

There should be explanation pages on the website that explain how each protocol should be used in i-score.

• OSC
• Minuit
• MIDI
• HTTP
• WebSockets
• Serial port
• OSCQuery