Skip to content

Commit

Permalink
Docs: Change structure
Browse files Browse the repository at this point in the history
  • Loading branch information
oyvindberg committed Mar 5, 2021
1 parent 7282da3 commit b6f3ec8
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 24 deletions.
6 changes: 0 additions & 6 deletions docs/changelog.md

This file was deleted.

4 changes: 1 addition & 3 deletions docs/library-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ id: library-developer
title: How to share code
---

The normal approach of using ScalablyTyped is geared towards writing applications.

If you want to distribute code written on top of ScalablyTyped, so there is now another workflow
If you want to distribute code written on top of ScalablyTyped, so there is a special workflow
for producing free-standing libraries based on the generated code.

## Example project
Expand Down
5 changes: 1 addition & 4 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ id: readme
title: The Javascript ecosystem for Scala.js!
---

Typescript is now used to describe almost all useful Javascript libraries.

This project aims to make all of that useful from Scala.js by converting typescript type definitions automatically in your build.


## Getting started
Expand All @@ -23,6 +20,6 @@ This project took [scala-js-ts-importer](https://github.com/sjrd/scala-js-ts-imp
and inherited a lot of decisions from it.

## License
ScalablyTypedConverter code is distributed under the [GPL version 3](https://opensource.org/licenses/GPL-3.0).
The ScalablyTyped Converter code is distributed under the [GPL version 3](https://opensource.org/licenses/GPL-3.0).
Everything else is MIT licensed.

21 changes: 11 additions & 10 deletions website/sidebars.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
{
"docs": {
"ScalablyTyped": [
"readme",
"usage",
"conversion-options",
"flavour",
"encoding",
"changelog",
"import-problems",
"remotecache"
],
"Getting started (application)": [
"plugin",
"plugin-no-bundler",
Expand All @@ -18,7 +8,18 @@
"Getting started (library)": [
"library-developer"
],
"Usage": [
"usage",
"objects",
"flavour",
"encoding"
],
"Configuration": [
"conversion-options",
"remotecache"
],
"Development": [
"import-problems",
"devel/about",
"devel/running"
]
Expand Down
2 changes: 1 addition & 1 deletion website/siteConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const users = [

const siteConfig = {
title: 'ScalablyTyped', // Title for your website.
tagline: 'The official website of the ScalablyTyped project',
tagline: 'The Javascript ecosystem for Scala.js!',
url: 'https://scalablytyped.org', // Your website URL
baseUrl: '/', // Base URL for your project */
// For github.io type URLs, you would set the url and baseUrl like:
Expand Down

0 comments on commit b6f3ec8

Please sign in to comment.