Git Product home page Git Product logo

frc-assistant's Introduction

FRC Assistant

This is an attempt to help share that institutional knowledge that most veteran FRC teams have with other teams. It's set up as an interactive fiction for folks to walk through to help guide them to what resources will help them.

Current Content Plan

Content Map

Contributing

Content is written in Ink I've tried to break major subsystems into unique files linked into the main ink file. I've done most of the writing in Inky. To publish overwrite the FRC Assistant.js file using the Export to JSON... option.

Adding a resource

Adding a resource is a two part process, first you must reference it in Ink using a tag in format of # { "resource": "path.to.resource"} then you add that resource to the resources.json file. This was done so updating new links to things requires a redeploy but not a regeneration of the Ink text. Also, and more honestly, because embedding links inside the Ink text required extensive escaping and was a general pain. This is easier, trust me.

Resources consist, minimally of the following structure:

"key": {
            "type": "resource",
            "link": "URI for accessing the resource",
            "thumbnail": "URI for accessing the displayed thumbnail, currently does not default to anything",
            "source": "Text for where you got this from, think of it as attribution"
        }

For now all resources should be of type 'resource'. The main reason for this in the structure is to enable more rich handling of resource types down the road should a need for that occur.

The path in the Ink file must match to the path in the resources.json or it won't be looked up properly and will be stripped out.

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.