Giter VIP home page Giter VIP logo

gosling-website's Introduction

A Documentation Website for Gosling.js

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

The above command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Gosling uses assets/gosling.schema.json to generate property tables.
If you have a local gosling.js repo and want to update the gosling.schema from that repo.
Assuming your gosling-website and gosling.js repos are in the same directory, you can run

cd assets
. copy.sh

Build

yarn build

The above command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

The Gosling-Website is deployed to AWS S3 BUCKET gosling-lang.org using this github action.

The deployment is trigger when a push is made to the main branch.

Versioning

website
├── versions.json        # file to indicate what versions are available
├── docs                 # the current underdevelopment docs, available at https://gosling-lang.org/docs/next/
│   ├── foo
│   └── bar.md        
├── versioned_docs
│   ├── version-0.9.30   # the latest version, available at https://gosling-lang.org/docs/
│   │   ├── foo.md  
│   │   └── bar.md
│   └── version-0.9.20   # an older version, available at https://gosling-lang.org/docs/0.9.20/
│       ├── foo
│       └── bar.md
├── sidebars.json        # sidebar for the current underdevelopment docs 
└── versioned_sidebars
    ├── version-0.9.30-sidebars.json
    └── version-0.9.20-sidebars.json

We will edit the ./docs whenever we make changes to gosling.js. When we are sure that the current docs (/docs) is ready to be frozen (typically when we bump a major gosling.js version), run the script below

yarn run tag_version x.x.x

This command will:

  • Copy the full ./docs folder contents into a new versioned_docs/version-<x.x.x> folder.
  • Create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-<x.x.x>-sidebars.json.
  • Append the new version number to versions.json.

gosling-website's People

Contributors

astridvandenbrandt avatar cjrosa23 avatar dependabot[bot] avatar etowahadams avatar sehilyi avatar solo7773 avatar wangqianwen0418 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

gosling-website's Issues

Add experimental options to docs?

We have several experimental options that can be useful for users already, such as

  • Performant rendering (e.g., experimental.stretchGraphics)
  • Mouse events (e.g., experimental.mouseEvents)

These would be useful to include in docs so that people are aware of these features. We can clarify that these are experimental by adding a note block, e.g.,

Warning

This is an experimental option that can be changed and removed in the future

Website home accessibility with keyboard & screen reader

The section of the home page of gosling-lang.org with example graphics that you can click on which will take you to the editor is hard to navigate with keyboard, because you first get all links and names, and then a set of unnamed buttons (which you can click on with mouse). Perhaps restructure this such that the HTML elements are ordered as button-link+desc-button-link+desc-etc.?

"Frequently Asked Questions" page or section?

People are actively asking questions about Gosling.js, and we can update our website to help future users find the proper information before asking.

While some descriptions can be added directly to existing pages of the documentation, some of them do not seem to have good-fitting sections or pages. We could probably create a "Frequently Asked Questions" page or section and provide those descriptions.

Such examples include, but not limited to,

Allowing to search keywords?

If can be added easily, it would be great to add a search box that allows users to find keywords in docs as in the Docusaurus webpage.

Screen Shot 2021-10-25 at 11 22 05 AM

Dark mode compatibility

In the dark mode,

  • Some parts of the website become difficult to read (e.g., "Get Started" on the home page and "Tips" on the public data page). We can update styles to make them more readable.
  • Code blocks become visually too highlighted. Perhaps, use a dark theme in the browser's dark mode?

Screenshots:
Screen Shot 2021-05-13 at 11 34 21 AM

Screen Shot 2021-05-13 at 11 33 40 AM

Screen Shot 2021-05-13 at 11 27 25 AM

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.