Documentation corrections

Aaron 's Avatar

Aaron

25 Jan, 2013 02:57 AM

What's the best way to recommend edits to the documentation/tutorials? I think we could all benefit from the many eyes reading through it and spotting potential improvements. Small example: http://nodebox.net/node/documentation/using/data-visualization.html states 'import_csv11'; should be 'import_csv1'.

Cheers!

  1. Support Staff 1 Posted by lucasnijs on 25 Jan, 2013 01:01 PM

    lucasnijs's Avatar

    You are absolutely right. We are looking into this and get back to you asap! Thanks for the tip.

  2. Support Staff 2 Posted by Frederik De Ble... on 25 Jan, 2013 06:06 PM

    Frederik De Bleser's Avatar

    The full source for the nodebox.net page is available on GitHub. If you have an account, you can press edit on any documentation page and suggest a change.

    For example, the page you mentioned is available here on GitHub. Pressing edit will fork the repository and allow you to submit a pull request (GitHub-speak for a "change request" or "suggestion").

    Alternatively, every page has a "Help & Support" widget on the right where you can make a suggestion directly. We read and respond to all messages.

    Thanks for helping out! We've fixed the issue you mentioned.

  3. 3 Posted by Aaron on 27 Jan, 2013 04:56 AM

    Aaron 's Avatar

    Frederik,
    I don't see the help and support widget you mentioned. But maybe because I'm not logged in at the moment?
    Cheers,
    Aaron

  4. Support Staff 4 Posted by Frederik De Ble... on 28 Jan, 2013 09:35 AM

    Frederik De Bleser's Avatar

    Weird. I've made a screenshot in Chrome. Is the widget not visible in your browser?

  5. 5 Posted by Aaron on 28 Jan, 2013 12:20 PM

    Aaron's Avatar

    Aha! I was in the discussion area rather than Documentation. I see it now!
    Thank you.

  6. Frederik De Bleser closed this discussion on 28 Jan, 2013 01:22 PM.

  7. Aaron re-opened this discussion on 29 Jan, 2013 04:00 AM

  8. 6 Posted by Aaron on 29 Jan, 2013 04:00 AM

    Aaron's Avatar

    It would be great if every node mentioned in the Reference (ie http://nodebox.net/node/reference/corevector/resample.html) also had a downloadable example! That would really help newbies or left-brain-challenged people like myself. Wonder what it would take to set that up.

  9. Support Staff 7 Posted by Frederik De Ble... on 29 Jan, 2013 02:30 PM

    Frederik De Bleser's Avatar

    We'd love to add examples to each node in the reference documentation. It would take a lot of effort, and of course, contributions are welcome!

Reply to this discussion

Internal reply

Formatting help / Preview (switch to plain text) No formatting (switch to Markdown)

Attaching KB article:

»

Attached Files

You can attach files up to 10MB

If you don't have an account yet, we need to confirm you're human and not a machine trying to post spam.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac

Recent Discussions

16 May, 2024 02:11 AM
16 May, 2024 01:58 AM
14 May, 2024 01:29 AM
13 May, 2024 12:36 AM
12 May, 2024 07:46 PM

 

05 May, 2024 04:38 PM
03 May, 2024 06:50 AM
03 May, 2024 12:30 AM
03 May, 2024 12:09 AM
19 Apr, 2024 04:41 AM
16 Apr, 2024 06:18 PM