Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Move to dedicated documentation site #155

Merged
merged 20 commits into from
May 22, 2019
Merged

[docs] Move to dedicated documentation site #155

merged 20 commits into from
May 22, 2019

Conversation

sman591
Copy link
Member

@sman591 sman591 commented May 22, 2019

Moves off the GitHub Wiki in favor of a Docusaurus setup.

Documentation is now maintained in code at docs/ (markdown files), with the website configuration & tooling stored in website/

This does increase the amount of code in the repo; we now store docs, screenshots, and some basic JS files for the website. However after a ton of thought between this and making a separate repo, I think this is ultimately the best path because it (a) keeps docs + feature development in the same place and (b) makes referencing code & docs way easier (don't have to switch between repos).

Commit to the master branch will auto-build on Travis and deploy to https://coderit.org/hackathon-manager/

@sman591 sman591 merged commit fa45732 into master May 22, 2019
@sman591 sman591 deleted the docusaurus branch May 22, 2019 17:55
*/

// This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
copyright: `Copyright © ${new Date().getFullYear()} codeRIT`,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'template literal syntax' is only available in ES6 (use 'esversion: 6').

],

// If you have users set above, you add it here:
users,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'object short notation' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).

},
];

const siteConfig = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'const' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).

// site configuration options.

// List of projects/orgs using your project for the users page.
const users = [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'const' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).

height="58"
/>
)}
</a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unclosed regular expression.
Unrecoverable syntax error. (50% scanned).


class Footer extends React.Component {
docUrl(doc, language) {
const baseUrl = this.props.config.baseUrl;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'const' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).


const React = require('react');

class Footer extends React.Component {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'class' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).

* LICENSE file in the root directory of this source tree.
*/

const React = require('react');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'const' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).

const SplashContainer = props => (
<div className="homeContainer">
<div className="homeSplashFade">
<div className="wrapper homeWrapper">{props.children}</div>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unclosed regular expression.
Unrecoverable syntax error. (11% scanned).

const langPart = `${language ? `${language}/` : ''}`;
const docUrl = doc => `${baseUrl}${docsPart}${langPart}${doc}`;

const SplashContainer = props => (
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'arrow function syntax (=>)' is only available in ES6 (use 'esversion: 6').
'const' is available in ES6 (use 'esversion: 6') or Mozilla JS extensions (use moz).

@sman591
Copy link
Member Author

sman591 commented May 23, 2019

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants