fix name of repository
Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
parent
5e9b7eff7e
commit
6ac1dc819c
|
@ -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
|
||||
|
||||
|
|
|
@ -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}}}
|
||||
|
|
|
@ -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`
|
||||
|
||||
|
|
|
@ -18,7 +18,7 @@ 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:
|
||||
|
||||
|
|
|
@ -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 <jakub@status.im>",
|
||||
"license": "MIT",
|
||||
"devDependencies": {
|
||||
|
|
Loading…
Reference in New Issue