Giter VIP home page Giter VIP logo

website's Introduction

⚠️ This repo is now deprecated, a new setup and design is on the way! ⚠️

amethyst.rs website

This project contains the official amethyst website, deployed at amethyst.rs and amethyst-engine.org.
It's built using gatsby.js and bulma, the content is hosted over at prismic while the app itself is hosted at netlify.

Development

If you want to run the website locally, just clone the repo, run npm install and then npm start or npm run develop to start the local development server. No environment variables are needed since the prismic repository is public due to our open source plan.

Docs and Book

The documentation and book have moved out of the website repository and can now be found at the subdomains docs.amethyst.rs and book.amethyst.rs. If you're interested in how they're built and deployed, you can check out amethyst-docs-builder, the service that makes sure they're up to date.

website's People

Contributors

happenslol avatar zacnomore avatar alvelarsson avatar azriel91 avatar fhaynes avatar piedoom avatar

Stargazers

Loweredgames avatar Barry Harris avatar Alexander avatar Michael Corrado avatar Matcha avatar Benjamin Levy avatar  avatar  avatar Sami Hamed avatar

Watchers

James Cloos avatar  avatar

website's Issues

Update the Roadmap

When I first found Amethyst, in mid-2019, I used to regularly check the Roadmap to see if any of the goals there had been accomplished, mainly the "iOS and Android Support" one. I wanted to use the engine, but had not really a reason to, as my goal at that time was to make mobile games.

I started to realize that the website wasn't cared of that much, and now it seems quite obsolete with those old goals there (which I have no idea if they were done or not, because I did not get involved with the project).

Maybe you/we could update that, possibily showing what has already been done, so that new people may see a reason to use Amethyst, instead of a reason to not to, by thinking it has been abandoned or something like that.

Fix dead links

1. https://amethyst.rs/doc

https://amethyst.rs/doc contains a dead link at

<h2>Previous Stable Version (0.12)</h2>
<!-- [... ] -->
    <li><a target="_blank" rel="noopener" href="https://docs.amethyst.rs/v0.12.0/amethyst/">Browse the API Reference</a></li>
<!-- [... ] -->
</ul>

Specifically, https://docs.amethyst.rs/v0.12.0/amethyst/returns a 404.

I don't know if they're still hosted under the amethyst.rs domain somewhere, alternatively you might want to link to https://docs.rs/amethyst/0.12.0/amethyst/ instead.

I'm not sure how to open a PR to fix this, when I search for the strings I can't find them in this repo, at least not on the master branch. It's probably in a different part of your build / content pipeline.

2. README.md

README.md links to https://amethyst-engine.org/ in line 3. The link appears to be unreachable.

Move to prismic graphql plugin

At the moment we're using the old prismic gatsby plugin, called gatsby-source-prismic. There's a few drawbacks to this:

  • The preview function doesn't work
  • There's a bug where the build fails if a rich text field starts with an image

A new plugin has been released by prismic, which uses their new graphql api directly and can be found here. There's 2 major changes that need to be done for us to switch to this:

  • We need to use the prismic-dom library since field parsing and conversion won't be included in the source plugin anymore.
  • Images will need to be checked for manual styling, since the new plugin doesn't support locally resizing the images using the sharp plugin. This should be fine though, as we're not too image-heavy and don't rely on them scaling fluidly too much.

Please ping me if anyone's interested in taking this on, since I probably won't do this myself very soon.

Add custom-rendered page for amethyst crates keyword

Could we be using crates.io as an API to display certain listings on our own website?

e.g. could we build a amethyst.rs/crates page that re-renders https://crates.io/keywords/amethyst?

Could be a handy way of going "looking for amethyst tooling? here's the current ecosystem".

Prior art:

Move to a two-main-column docs page

image

I was a little disoriented at first from the progression, being Stable -> Previous -> Master. As we continue to add more releases, we will continue to have a greater separation between stable and master. We also don't want to put master at the top, since we want to encourage users to use stable. Instead, we can put them in a special row with two columns.

image

If you agree, I can also implement this.

Add support for title backgrounds on articles and page slices

The page titles are all very plain right now, both for pages and blog articles. It should be possible to have a background for the title (similar to how medium articles have a title image), probably dimmed a little so that the text remains readable.

This should be implemented as an extra field that will be ignored if not present on articles, and as an extra slice type for static pages. If you're interested in working on this, hit me up and I'll add the types to prismic so the frontend can be developed for it.

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.