Skip to content

Site Structure #1

@ForbesLindesay

Description

@ForbesLindesay

I propose the following site structure:

/ => The site's home page should contain a listing of all available components (paged if need be) with a search box and links to a few other key parts of the site. The components in this listing should display their license and number of stars on GitHub. They should be grouped by category based on the wiki, and sorted by number of stars in GitHub, then alphabetically within that.

/about => this userID is not available in GitHub, I think it should contain an introduction to Components + a Getting Started guide with accompanying video and a few sample projects in GitHub.

/:user => should show a listing of all the components a given user has produced, it should look very much like the one displayed on the home screen.

/:user/:repo => The primary listing page for each component. It needs to display some key info about the repo: browser compatibility based on automated tests, License, number of stars, dependencies, dependants, installation instructions/links to different pre-made builds. I would like to also display the readme with an automated table of contents so that this can be used as the home page for most components.

/:user/:repo/download => Listing for downloads of the component. This should include minified and unminified. standalone builds of each version of the library, it should also include a build of the library that doesn't include any dependencies or the require script so that you could have:

<script src="https://component.io/require.js"></script>
<script src="https://component.io/foo/bar/download.js"></script>
<script src="https://component.io/foo/baz/download.js"></script>
<script>
  var bar = require('bar');
  var baz = require('baz');
</script>

We need to decide exactly how we structure the URLs for download links. We need to have at least one link to the latest standalone unminified build as that will allow us to get most of the components submitted to microjs.com (see microjs/microjs.com#344)

/component-badge.svg => should serve the SVG for the component badge:

badge

Anyone got any to add/not like any of these?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions