Code Monkey home page Code Monkey logo

fyi's Introduction

expo.fyi

tl;dr: it's a tool to link people to markdown files in https://github.com/expo/fyi with a concise and pretty link, eg: https://expo.fyi/bundle-identifier

What is it?

This website is a useful URL shortener that redirects users to a markdown file on the https://github.com/expo/fyi repository. For example, https://expo.fyi/bundle-identifier will redirect the user to https://github.com/expo/fyi/blob/master/bundle-identifier.md.

It is useful to remove any friction to creating a shareable link to a persistent explanation of some piece of knowledge that is useful to developers using Expo tools.

Why might I want to use this?

Imagine that you're working on expo-cli and want to add more context on some terminology that you are using in a prompt to the user. Maybe you need to ask them for a "bundle identifier". You want to make sure that the user has easy access to more information about what that means, but you don't want to inline a whole explanation of it and crowd the interface. At the same time, you can't be bothered to create a docs page for this, or maybe the existing docs page doesn't provide the most relevant context for the situation the user is in. That's understandable. So instead let's just create a FYI!

How do I create a FYI?

๐Ÿ’กFYI

  • You can add any arbitrary string like this-does-not-exist to the URL and it will just bring you to the GitHub 404 pages: https://expo.fyi/this-does-not-exist. You probably do not want to do this, so instead create a file and link to it, and don't delete the file if it's linked to from somewhere already.
  • If you go to https://expo.fyi it will just redirect you to the GitHub repo
  • You can create your own domain like this by cloning https://github.com/expo/expo-fyi - a small service that you can deploy to now.sh. Customize the URLs it uses in index.js.

fyi's People

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.