Skip to content

More long-form documentation #1677

@SquidDev

Description

@SquidDev

Occasionally I have an idea for a documentation page it might be nice to have, but then never write it down and eventually forget! This issue serves as a list of pages that I think would be useful to have.

Tutorials

  • A turtle control program, serving as an introduction to rednet. See my comments in Add guide to using Rednet #1647 (review) for more information.

  • Printing random quotes: I'm not entirely sure about this. On one hand, I think this could be a quite simple and fun project, on the other hand, maybe printers aren't quite worth the effort.

    That said, I'm thinking of something following the rough path:

    1. Setting up a printer and printing a basic page.
    2. Picking a random quote and printing it.
    3. Word wrapping.
    4. [Advanced] Using multiple printers to print with different colours.

Reference

  • Datapack reference: While we do have some documentation for datapacks in the datapack-example repository, it would be good to have something a little more visible and comprehensive.

    I'm not entirely sure what the structure should look like here. We want to include all the following, without it getting too messy:

    • All of CC:T's behaviour-changing tags (turtle can place/use, turtle breakability).
    • Turtle tools (schema and explanation). We've already got this in the data-generator javadoc, just need to make it more visible.
    • Extending the ROM.

    As an aside, it would be kinda neat (though probably overkill!) to have a web-based builder for datapacks in the vein of Vanilla Tweaks. Maybe a fun weekend project?

  • Redo the Lua compatibility page, so it's feature-oriented (grouped by library) rather than version-oriented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area-DocumentationImproving/fixing documentationenhancementAn extension of a feature or a new feature.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions