From 6ac1dc819c3529f0cd1c4be74b5fa1de40d07bc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Soko=C5=82owski?= Date: Wed, 11 Mar 2020 17:50:12 +0100 Subject: [PATCH] fix name of repository MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Jakub Sokołowski --- README.md | 8 ++++---- README.template | 2 +- bin/deploy.js | 2 +- docs/about.md | 4 ++-- package.json | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f5ecc66..678e2e8 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,8 @@ You need: ## Building ```bash -git clone https://github.com/status-im/nimbus-docs-suite -cd nimbus-docs-suite +git clone https://github.com/status-im/nimbus-libs-site +cd nimbus-libs-site cd docgen && yarn install vuepress build ``` @@ -69,7 +69,7 @@ Those subdocs are assumed to be listed in a subsection with links e.g. `"subdocs If these subdocs have H1 level headings, all headings will be moved 1 level lower (i.e. `##` becomes `###`). The subsection will be replaced with a content composed of all subdocs merged into a single file. -@todo currently image URLs are not fixed because it's [not straightforward](https://github.com/status-im/nimbus-docs-suite/issues/6). +@todo currently image URLs are not fixed because it's [not straightforward](https://github.com/status-im/nimbus-libs-site/issues/6). ### ApiRef @@ -90,7 +90,7 @@ If the `bootstrap` option is provided, the generator will run this command verba ## Enhancing the docs further -To further enhance the docs, please consult the [Vuepress docs](https://v1.vuepress.vuejs.org) as underneath it's all just a [Vue](https://vuejs.org) app built by Vuepress. Also check [existing issues](https://github.com/status-im/nimbus-docs-suite/issues). +To further enhance the docs, please consult the [Vuepress docs](https://v1.vuepress.vuejs.org) as underneath it's all just a [Vue](https://vuejs.org) app built by Vuepress. Also check [existing issues](https://github.com/status-im/nimbus-libs-site/issues). ## License diff --git a/README.template b/README.template index 581fed2..6ce42b4 100644 --- a/README.template +++ b/README.template @@ -26,6 +26,6 @@ Documentation is organized into four categories: tutorials, overviews, API refer ## Get Started -Use the search field in the header, or find a desired library in the sections below. Each library has its own documentation with a full API reference and guides. If you'd like to contribute to these docs with your own work or some corrections, please file issues or PRs [in the Github repo](https://github.com/status-im/nimbus-docs-suite). +Use the search field in the header, or find a desired library in the sections below. Each library has its own documentation with a full API reference and guides. If you'd like to contribute to these docs with your own work or some corrections, please file issues or PRs [in the Github repo](https://github.com/status-im/nimbus-libs-site). {{{libraries}}} diff --git a/bin/deploy.js b/bin/deploy.js index 4dacdda..878435d 100755 --- a/bin/deploy.js +++ b/bin/deploy.js @@ -8,7 +8,7 @@ process.on('unhandledRejection', err => { throw err }) const distDir = 'docs/.vuepress/dist' const branch = 'gh-pages' const org = 'status-im' -const repo = 'status-libs-site' +const repo = 'nimbus-libs-site' /* use SSH auth by default */ var repoUrl = `git@github.com:${org}/${repo}.git` diff --git a/docs/about.md b/docs/about.md index 14301e1..edbda01 100644 --- a/docs/about.md +++ b/docs/about.md @@ -18,9 +18,9 @@ We actually do use Nimdoc for the API reference included in each library's docum ## Contributing -You can contribute to these docs by submitting issues or pull requests in the official repository at [status-im/nimbus-docs-suite](https://github.com/status-im/nimbus-docs-suite). +You can contribute to these docs by submitting issues or pull requests in the official repository at [status-im/nimbus-libs-site](https://github.com/status-im/nimbus-libs-site). Keep in mind the following: - the API reference is generated from individual libraries. Thus, if you notice a mistake in the API reference, to submit a fix you should submit a PR to the library in question and fix its docblock. -- the guides are curated and not everything that's written about the libraries will be included here. \ No newline at end of file +- the guides are curated and not everything that's written about the libraries will be included here. diff --git a/package.json b/package.json index 0e089b3..cfa15a7 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { - "name": "nimbus-docs-suite", + "name": "nimbus-libs-site", "version": "1.0.0", "description": "A Vuepress-powered documentation generator for Nimbus libraries", - "repository": "git@github.com:status-im/nimbus-docs-suite.git", + "repository": "git@github.com:status-im/nimbus-libs-site.git", "author": "Jakub Sokołowski ", "license": "MIT", "devDependencies": {