Coder Social home page Coder Social logo

xod-docs's Issues

List handling: Lists, Views, Iterators, XString

These topics are important to make new C++ nodes but are not covered anyhow:

  • Reading XOD strings: iterating, dumping to a buffer
  • Producing XOD strings: views, lifetime, double buffering
  • Using custom type lists, implementing new view types

Hardware libraries style guide

As mentioned in #63 (comment):

We have a few conventions that are scattered through the docs or even unwritten.
For example:

We have a few conventions that are scattered through the docs or even unwritten.
For example:

  • any nodes that create a new type to work with hardware should be named as xxx-device
  • node that initialises hardware module should be named init
  • names of any nodes which do instructions "what to do" in imperative style must begin with a verb (init, read-byte, pair-tag, write-line, etc)
  • nodes that "unfold" complex types into more primitive ones are named unpack-xxx
  • example patches are named example-xxx
    (and probably a few others that I forgot to mention)

It will be cool to summarize these in a single guide article.

Setup Markdown linter

Rationale

XOD docs in this repository is a code that should be formatted properly. We have Prettier, but formatting with it is not enforced. We can’t actually make pretty-printing check a part of PR validation because it is too strict, thus it will confuse people who just want to fix a typo involving a slight paragraph reflow. Such PRs should not trigger a CI error.

So, a linter should be more relaxed than the prettier check. Here is a possible solution: https://github.com/markdownlint/markdownlint

Acceptance criteria

  • I can yarn lint to check everything with the linter
  • Max line length is set to 100
  • All existing content is tweaked to pass the linter check
  • After doing yarn prettier:all the yart lint produces no errors
  • CircleCI is set up and invokes the linter on PRs

Make reference/shortcuts use YAML data

Currently, the shortcuts reference list items through plain HTML tables.

The items are a highly structured data that might be defined in a YAML file. This way is preferable because if we want to make a slight change in the HTML markup, we are in trouble: changes in every line of the table across all translations will be required.

To support translations the YAML source can have a separate description field for every language:

- shortcut:
    mac: ⌘ N
    pc: Ctrl+N
    action:
      EN: "New patch"
      DE: "Neu patch"
      RU: "Новый патч"

XOD 104 Button

In the tutorial. The Diagram shows the button set to D0
In the Pictorial, the Button is wired to D13

This created confusion when I went to try the tutorial. What saved me is that it specifically states to set the port value of the button node. this created some confusion to set to 0 per picture or 13 per the wire diagram.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.