Skip to content

Commit

Permalink
refactor: move documentation site to Netlify
Browse files Browse the repository at this point in the history
  • Loading branch information
geromegrignon committed Dec 22, 2021
1 parent 4938439 commit a3855ae
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<a href="https://demo.realworld.io/"><img src="media/conduit_l.png" align="right" width="250px" /></a>

### See how *the exact same* Medium.com clone (called [Conduit](https://demo.realworld.io)) is built using different [frontends](https://codebase.show/projects/realworld?category=frontend) and [backends](https://codebase.show/projects/realworld?category=backend). Yes, you can mix and match them, because **they all adhere to the same [API spec](https://gothinkster.github.io/realworld/docs/specs/backend-specs/introduction)** 😮😎
### See how *the exact same* Medium.com clone (called [Conduit](https://demo.realworld.io)) is built using different [frontends](https://codebase.show/projects/realworld?category=frontend) and [backends](https://codebase.show/projects/realworld?category=backend). Yes, you can mix and match them, because **they all adhere to the same [API spec](https://realworld-docs.netlify.app/docs/specs/backend-specs/introduction)** 😮😎

While most "todo" demos provide an excellent cursory glance at a framework's capabilities, they typically don't convey the knowledge & perspective required to actually build _real_ applications with it.

Expand All @@ -25,7 +25,7 @@ Explore them on [**CodebaseShow**](https://codebase.show/projects/realworld).

# Create a new implementation

[**Create a new implementation >>>**](https://gothinkster.github.io/realworld/docs/implementation-creation/introduction)
[**Create a new implementation >>>**](https://realworld-docs.netlify.app/docs/implementation-creation/introduction)

Or you can [view upcoming implementations (WIPs)](https://github.com/gothinkster/realworld/discussions/categories/wip-implementations).

Expand All @@ -35,7 +35,7 @@ Or you can [view upcoming implementations (WIPs)](https://github.com/gothinkster
- Every tutorial is built against the same [API spec](api/) to ensure modularity of every frontend & backend
- Every frontend utilizes the same handcrafted [Bootstrap 4 theme](https://github.com/gothinkster/conduit-bootstrap-template) for identical UI/UX
- There is a hosted version of the backend API available for public usage, no API keys are required
- Interested in creating a new RealWorld stack? View our [starter guide & spec](https://gothinkster.github.io/realworld/docs/implementation-creation/introduction)
- Interested in creating a new RealWorld stack? View our [starter guide & spec](https://realworld-docs.netlify.app/docs/implementation-creation/introduction)

# Active Maintainers

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/community/authors.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 2

# Who made this?

RealWorld would not be possible without the [open source community](https://gothinkster.github.io/realworld/docs/community/special-thanks) continuously helping push the project forward. In addition, the former team was composed of:
RealWorld would not be possible without the [open source community](https://realworld-docs.netlify.app/docs/community/special-thanks) continuously helping push the project forward. In addition, the former team was composed of:

#### [Anish Karandikar](https://github.com/anishkny) - Core Maintainer

Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Or you can [view upcoming implementations (WIPs)](https://github.com/gothinkster
- ["Introducing RealWorld 🙌"](https://medium.com/@ericsimons/introducing-realworld-6016654d36b5) by Eric Simons
- Every tutorial is built against the same [API spec](specs/backend-specs/introduction) to ensure modularity of every frontend & backend
- Every frontend utilizes the same hand crafted [Bootstrap 4 theme](https://github.com/gothinkster/conduit-bootstrap-template) for identical UI/UX
- There is a [hosted version](https://gothinkster.github.io/realworld/docs/specs/frontend-specs/api#demo-api) of the backend API available for public usage, no API keys are required
- There is a [hosted version](https://realworld-docs.netlify.app/docs/specs/frontend-specs/api#demo-api) of the backend API available for public usage, no API keys are required
- Interested in creating a new RealWorld stack? View our [starter guide & spec](implementation-creation/introduction)

[![Brought to you by Thinkster](/img/end.png)](https://thinkster.io)
2 changes: 1 addition & 1 deletion documentation/docs/specs/backend-specs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ All backend implementations need to adhere to our [API spec](https://github.com/

For your convenience, we have a [Postman collection](https://github.com/gothinkster/realworld/blob/main/api/Conduit.postman_collection.json) that you can use to test your API endpoints as you build your app.

Check out our [starter kit](https://github.com/gothinkster/realworld-starter-kit) to create a new implementation, please read [references to the API specs & testing](https://gothinkster.github.io/realworld/docs/specs/backend-specs/introduction) required for creating a new backend.
Check out our [starter kit](https://github.com/gothinkster/realworld-starter-kit) to create a new implementation, please read [references to the API specs & testing](https://realworld-docs.netlify.app/docs/specs/backend-specs/introduction) required for creating a new backend.
2 changes: 1 addition & 1 deletion documentation/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
(module.exports = {
title: 'RealWorld',
tagline: 'The mother of all demo apps',
url: 'http://gothinkster.github.io/realworld/',
url: 'https://realworld-docs.netlify.app/',
baseUrl: '/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
Expand Down

0 comments on commit a3855ae

Please sign in to comment.