chore: remove docs build (#17791)

This commit is contained in:
Marko 2023-09-19 12:03:40 +02:00 committed by GitHub
parent 16293120ab
commit 4ef0130bcd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
182 changed files with 188 additions and 24392 deletions

View File

@ -9,14 +9,6 @@ updates:
interval: daily
time: "01:00"
- package-ecosystem: npm
directory: "/docs"
schedule:
interval: weekly
# DevRel should review docs updates
assignees:
- "julienrbrt"
- package-ecosystem: gomod
directory: "/"
schedule:

View File

@ -1,38 +0,0 @@
name: Build Docs
# This workflow runs when a PR is labeled with `docs`
# This will check if the docs build successfully by running `make build-docs`
on:
pull_request:
branches:
- main
- "release/**"
paths:
- "docs/**"
- "x/**/*.md"
- .github/workflows/deploy-docs.yml
- .github/workflows/build-docs.yml
permissions:
contents: read
jobs:
check-docs-build:
name: Check docs build
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v4
with:
persist-credentials: false
fetch-depth: 0
- name: Setup Node.js 🔧
uses: actions/setup-node@v3
with:
node-version: "16.x"
# npm install npm should be removed when https://github.com/npm/cli/issues/4942 is fixed
- name: Build docs 🔧
run: |
npm install -g npm@8.5.5
make build-docs

View File

@ -1,47 +0,0 @@
name: Deploy docs
# This job builds and deploys documenation to github pages.
# It runs on every push to main with a change in the docs folder.
on:
workflow_dispatch:
push:
branches:
- main
- "release/**"
paths:
- "docs/**"
- "x/**/*.md"
- .github/workflows/deploy-docs.yml
permissions:
contents: read
jobs:
build-and-deploy:
permissions:
contents: write # for JamesIves/github-pages-deploy-action to push changes in repo
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@v4
with:
persist-credentials: false
fetch-depth: 0
path: "."
- name: Setup Node.js 🔧
uses: actions/setup-node@v3
with:
node-version: "16.x"
# npm install npm should be removed when https://github.com/npm/cli/issues/4942 is fixed
- name: Build 🔧
run: |
npm install -g npm@8.5.5
make build-docs
# - name: Deploy 🚀
# uses: JamesIves/github-pages-deploy-action@v4.4.3
# with:
# branch: gh-pages
# folder: ~/output
# single-commit: true

2
.gitignore vendored
View File

@ -13,7 +13,7 @@ private
# Build
vendor
build
/build
dist
tools-stamp
buf-stamp

View File

@ -174,11 +174,6 @@ godocs:
go install golang.org/x/tools/cmd/godoc@latest
godoc -http=:6060
build-docs:
@cd docs && DOCS_DOMAIN=docs.cosmos.network sh ./build-all.sh
.PHONY: build-docs
###############################################################################
### Tests & Simulation ###
###############################################################################

46
docs/.gitignore vendored
View File

@ -1,38 +1,14 @@
# Dependencies
/node_modules
# Production
build
!docs/build
# Generated files
.docusaurus
.cache-loader
versioned_docs
versioned_sidebars
docs/node_modules
docs/docs/modules
docs/docs/spec
docs/docs/architecture
docs/docs/rfc
docs/docs/tooling/01-cosmovisor.md
docs/docs/tooling/02-confix.md
docs/docs/tooling/03-hubl.md
docs/docs/core/17-autocli.md
docs/docs/packages/01-depinject.md
docs/docs/packages/02-collections.md
docs/docs/packages/03-orm.md
docs/modules
docs/spec
docs/architecture
docs/rfc
docs/tooling/01-cosmovisor.md
docs/tooling/02-confix.md
docs/tooling/03-hubl.md
docs/core/17-autocli.md
docs/packages/01-depinject.md
docs/packages/02-collections.md
docs/packages/03-orm.md
docs/user/run-node/04-rosetta.md
docs/build/migrations/02-upgrading.md
docs/develop/advanced/17-autocli.md
# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local
npm-debug.log*
yarn-debug.log*
yarn-error.log*

View File

@ -1,82 +1,7 @@
# Updating the docs
::note
The documentation is built from [cosmos-sdk-docs repo](https://github.com/cosmos/cosmos-sdk-docs) and is hosted on [docs.cosmos.network](https://docs.cosmos.network).
:::
If you want to open a PR in Cosmos SDK to update the documentation, please follow the guidelines in [`CONTRIBUTING.md`](https://github.com/cosmos/cosmos-sdk/tree/main/CONTRIBUTING.md#updating-documentation) and the [Documentation Writing Guidelines](./DOC_WRITING_GUIDELINES.md).
## Stack
The documentation for Cosmos SDK is hosted at https://docs.cosmos.network and built from the files in the `/docs` directory.
It is built using the following stack:
* [Docusaurus 2](https://docusaurus.io)
* Vuepress (pre v0.47)
* [Algolia DocSearch](https://docsearch.algolia.com/)
```js
algolia: {
appId: "QLS2QSP47E",
apiKey: "067b84458bfa80c295e1d4f12c461911",
indexName: "cosmos_network",
contextualSearch: false,
},
```
* GitHub Pages
## Docs Build Workflow
The docs are built and deployed automatically on GitHub Pages by a [GitHub Action workflow](../.github/workflows/deploy-docs.yml).
The workflow is triggered on every push to the `main` and `release/v**` branches, every time documentations or specs are modified.
### How It Works
There is a GitHub Action listening for changes in the `/docs` directory for the `main` branch and each supported version branch (e.g. `release/v0.46.x`). Any updates to files in the `/docs` directory will automatically trigger a website deployment. Under the hood, the private website repository has a `make build-docs` target consumed by a Github Action within that repository.
## How to Build the Docs Locally
Go to the `docs` directory and run the following commands:
```shell
cd docs
npm install
```
For starting only the current documentation, run:
```shell
npm start
```
It runs `pre.sh` scripts to get all the docs that are not already in the `docs/docs` folder.
It also runs `post.sh` scripts to clean up the docs and remove unnecessary files when quitting.
Note, the command above only build the docs for the current versions.
With the drawback that none of the redirections works. So, you'll need to go to /main to see the docs.
To build all the docs (including versioned documentation), run:
```shell
make build-docs
```
## What to for new major SDK versions
When a new major version of the SDK is released, the following steps should be taken:
* On the `release/vX.Y.Z` branch, remove the deploy action (`.github/workflows/deploy-docs.yml`), for avoiding deploying the docs from the release branches.
* On the `release/vX.Y.Z` branch, update `docusaurus.config.js` and set the `lastVersion` to `current`, remove all other versions from the config.
* Each time a new version is released (on docusaurus), drop support from the oldest versions.
* If the old version is still running vuepress (v0.45, v0.46), remove its line from `vuepress_versions`
* If any, remove the outdated redirections from `docusaurus.config.js` and add the base version redirection (`/vX.XX`) to `/main`.
```js
{
from: ["/", "/master", "/v0.43", "/v0.44", "/v0.XX"], // here add the deprecated version
to: "/main",
},
```
* Add the new version sidebar to the list of versionned sidebar and add the version to `versions.json`.
* Update the latest version (`presets[1].docs.lastVersion`) in `docusaurus.config.js`.
* Add the new version with in `presets[1].docs.versions` in `docusaurus.config.js`.
Learn more about [versioning](https://docusaurus.io/docs/versioning) in Docusaurus.

View File

@ -1,3 +0,0 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};

View File

@ -1,29 +0,0 @@
#!/bin/sh
# This builds the docs.cosmos.network docs using docusaurus.
# Old documentation, which have not been migrated to docusaurus are generated with vuepress.
COMMIT=$(git rev-parse HEAD)
mkdir -p ~/versioned_docs ~/versioned_sidebars
for version in $(jq -r .[] versions.json); do
echo "building docusaurus $version docs"
git clean -fdx && git reset --hard && git checkout release/$version.x
./pre.sh
npm ci && npm run docusaurus docs:version $version
mv ./versioned_docs/* ~/versioned_docs/
mv ./versioned_sidebars/* ~/versioned_sidebars/
done
echo "building docusaurus main docs"
(git clean -fdx && git reset --hard && git checkout $COMMIT)
mv ~/versioned_docs ~/versioned_sidebars .
npm ci && npm run build
mv build ~/output
echo "adding swagger docs"
cp -r ../client/docs/swagger-ui ~/output/swagger
while read -r branch path_prefix; do
echo "building vuepress $branch docs"
(git clean -fdx && git reset --hard && git checkout $branch && npm install && VUEPRESS_BASE="/$path_prefix/" npm run build)
mkdir -p ~/output/$path_prefix
cp -r .vuepress/dist/* ~/output/$path_prefix/
done < vuepress_versions
echo "setup domain"
echo $DOCS_DOMAIN > ~/output/CNAME

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 80 KiB

View File

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

View File

Before

Width:  |  Height:  |  Size: 58 KiB

After

Width:  |  Height:  |  Size: 58 KiB

View File

Before

Width:  |  Height:  |  Size: 238 KiB

After

Width:  |  Height:  |  Size: 238 KiB

View File

Before

Width:  |  Height:  |  Size: 268 KiB

After

Width:  |  Height:  |  Size: 268 KiB

View File

Before

Width:  |  Height:  |  Size: 243 KiB

After

Width:  |  Height:  |  Size: 243 KiB

View File

Before

Width:  |  Height:  |  Size: 331 KiB

After

Width:  |  Height:  |  Size: 331 KiB

View File

@ -1,446 +0,0 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
const lastVersion = "v0.47"; // TODO change with v0.50 at release.
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Cosmos SDK",
tagline:
"Cosmos SDK is the world's most popular framework for building application-specific blockchains.",
url: "https://docs.cosmos.network",
baseUrl: "/",
onBrokenLinks: "warn",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon.svg",
trailingSlash: false,
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "cosmos",
projectName: "cosmos-sdk",
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "en",
locales: ["en"],
},
presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve("./sidebars.js"),
routeBasePath: "/",
lastVersion: lastVersion,
versions: {
current: {
path: "main",
banner: "unreleased",
},
"v0.50": {
path: "v0.50",
label: "v0.50",
},
"v0.47": {
path: "v0.47",
label: "v0.47",
},
},
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
image: "img/banner.jpg",
docs: {
sidebar: {
autoCollapseCategories: true,
},
},
navbar: {
title: "Cosmos SDK",
hideOnScroll: false,
logo: {
alt: "Cosmos SDK Logo",
src: "img/logo-sdk.svg",
href: "https://docs.cosmos.network",
target: "_self",
},
items: [
{
href: "https://github.com/cosmos/cosmos-sdk",
html: `<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="github-icon">
<path fill-rule="evenodd" clip-rule="evenodd" d="M12 0.300049C5.4 0.300049 0 5.70005 0 12.3001C0 17.6001 3.4 22.1001 8.2 23.7001C8.8 23.8001 9 23.4001 9 23.1001C9 22.8001 9 22.1001 9 21.1001C5.7 21.8001 5 19.5001 5 19.5001C4.5 18.1001 3.7 17.7001 3.7 17.7001C2.5 17.0001 3.7 17.0001 3.7 17.0001C4.9 17.1001 5.5 18.2001 5.5 18.2001C6.6 20.0001 8.3 19.5001 9 19.2001C9.1 18.4001 9.4 17.9001 9.8 17.6001C7.1 17.3001 4.3 16.3001 4.3 11.7001C4.3 10.4001 4.8 9.30005 5.5 8.50005C5.5 8.10005 5 6.90005 5.7 5.30005C5.7 5.30005 6.7 5.00005 9 6.50005C10 6.20005 11 6.10005 12 6.10005C13 6.10005 14 6.20005 15 6.50005C17.3 4.90005 18.3 5.30005 18.3 5.30005C19 7.00005 18.5 8.20005 18.4 8.50005C19.2 9.30005 19.6 10.4001 19.6 11.7001C19.6 16.3001 16.8 17.3001 14.1 17.6001C14.5 18.0001 14.9 18.7001 14.9 19.8001C14.9 21.4001 14.9 22.7001 14.9 23.1001C14.9 23.4001 15.1 23.8001 15.7 23.7001C20.5 22.1001 23.9 17.6001 23.9 12.3001C24 5.70005 18.6 0.300049 12 0.300049Z" fill="currentColor"/>
</svg>
`,
position: "right",
},
{
type: "docsVersionDropdown",
position: "left",
dropdownActiveClassDisabled: true,
// versions not yet migrated to docusaurus
dropdownItemsAfter: [
{
href: "https://docs.cosmos.network/v0.46/",
label: "v0.46",
target: "_self",
},
{
href: "https://docs.cosmos.network/v0.45/",
label: "v0.45",
target: "_self",
},
],
},
],
},
footer: {
links: [
{
items: [
{
html: `<a href="https://cosmos.network"><img src="/img/logo-bw.svg" alt="Cosmos Logo"></a>`,
},
],
},
{
title: "Documentation",
items: [
{
label: "Cosmos Hub",
href: "https://hub.cosmos.network",
},
{
label: "CometBFT",
href: "https://docs.cometbft.com",
},
{
label: "IBC Go",
href: "https://ibc.cosmos.network",
},
],
},
{
title: "Community",
items: [
{
label: "Blog",
href: "https://blog.cosmos.network",
},
{
label: "Forum",
href: "https://forum.cosmos.network",
},
{
label: "Discord",
href: "https://discord.gg/cosmosnetwork",
},
{
label: "Reddit",
href: "https://reddit.com/r/cosmosnetwork",
},
],
},
{
title: "Social",
items: [
{
label: "Discord",
href: "https://discord.gg/cosmosnetwork",
},
{
label: "Twitter",
href: "https://twitter.com/cosmos",
},
{
label: "Youtube",
href: "https://www.youtube.com/c/CosmosProject",
},
{
label: "Telegram",
href: "https://t.me/cosmosproject",
},
],
},
],
copyright: `<p>The development of the Cosmos SDK is led primarily by <a href="https://interchain.io/ecosystem">Interchain Core Teams</a>. Funding for this development comes primarily from the Interchain Foundation, a Swiss non-profit.</p>`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ["protobuf", "go-module"], // https://prismjs.com/#supported-languages
},
algolia: {
appId: "QLS2QSP47E",
apiKey: "4d9feeb481e3cfef8f91bbc63e090042",
indexName: "cosmos_network",
contextualSearch: false,
},
}),
themes: ["@you54f/theme-github-codeblock"],
plugins: [
async function myPlugin(context, options) {
return {
name: "docusaurus-tailwindcss",
configurePostCss(postcssOptions) {
postcssOptions.plugins.push(require("postcss-import"));
postcssOptions.plugins.push(require("tailwindcss/nesting"));
postcssOptions.plugins.push(require("tailwindcss"));
postcssOptions.plugins.push(require("autoprefixer"));
return postcssOptions;
},
};
},
[
"@docusaurus/plugin-google-analytics",
{
trackingID: "UA-51029217-2",
anonymizeIP: true,
},
],
[
"@docusaurus/plugin-client-redirects",
{
fromExtensions: ["html"],
toExtensions: ["html"],
createRedirects(existingPath) {
return [
existingPath.replace('/core', '/develop/advanced'),
existingPath.replace('/basics', '/develop/beginner'),
existingPath.replace('/intro', '/develop/intro'),
existingPath.replace('/architecture', '/build/architecture/'),
existingPath.replace('/building-apps', '/build/building-apps'),
existingPath.replace('/building-modules', '/build/building-modules'),
existingPath.replace('/tooling', '/build/tooling'),
existingPath.replace('/migrations', '/build/migrations'),
existingPath.replace('/modules', '/build/modules'),
existingPath.replace('/rfc', '/build/rfc'),
existingPath.replace('/spec', '/build/spec'),
existingPath.replace('/tooling', '/build/tooling'),
existingPath.replace('/run-node', '/user/run-node'),
existingPath.replace('/validate', '/user/validate')
];
},
redirects: [
{
from: ["/", "/master", "/v0.43", "/v0.44"],
to: "/main",
},
{
from: [
"/main/modules/auth/01_concepts",
"/main/modules/auth/02_state",
"/main/modules/auth/03_antehandlers",
"/main/modules/auth/04_keepers",
"/main/modules/auth/06_params",
"/main/modules/auth/07_client",
],
to: "/main/build/modules/auth",
},
{
from: "/main/modules/auth/05_vesting",
to: "/main/build/modules/auth/vesting",
},
{
from: [
"/main/modules/authz/01_concepts",
"/main/modules/authz/02_state",
"/main/modules/authz/03_messages",
"/main/modules/authz/04_events",
"/main/modules/authz/05_client",
],
to: "/main/build/modules/authz",
},
{
from: [
"/main/modules/bank/01_state",
"/main/modules/bank/02_keepers",
"/main/modules/bank/04_events",
"/main/modules/bank/05_params",
"/main/modules/bank/06_client",
],
to: "/main/build/modules/bank",
},
{
from: [
"/main/modules/crisis/01_state",
"/main/modules/crisis/02_messages",
"/main/modules/crisis/03_events",
"/main/modules/crisis/04_params",
"/main/modules/crisis/05_client",
],
to: "/main/build/modules/crisis",
},
{
from: [
"/main/modules/distribution/01_concepts",
"/main/modules/distribution/02_state",
"/main/modules/distribution/03_begin_block",
"/main/modules/distribution/04_messages",
"/main/modules/distribution/05_hooks",
"/main/modules/distribution/06_events",
"/main/modules/distribution/07_params",
"/main/modules/distribution/08_client",
],
to: "/main/build/modules/distribution",
},
{
from: [
"/main/modules/evidence/01_concepts",
"/main/modules/evidence/02_state",
"/main/modules/evidence/03_messages",
"/main/modules/evidence/04_events",
"/main/modules/evidence/05_params",
"/main/modules/evidence/06_begin_block",
"/main/modules/evidence/07_client",
],
to: "/main/build/modules/evidence",
},
{
from: [
"/main/modules/feegrant/01_concepts",
"/main/modules/feegrant/02_state",
"/main/modules/feegrant/03_messages",
"/main/modules/feegrant/04_events",
"/main/modules/feegrant/05_client",
],
to: "/main/build/modules/feegrant",
},
{
from: [
"/main/modules/gov/01_concepts",
"/main/modules/gov/02_state",
"/main/modules/gov/03_messages",
"/main/modules/gov/04_events",
"/main/modules/gov/05_future_improvements",
"/main/modules/gov/06_params",
"/main/modules/gov/07_client",
"/main/modules/gov/08_metadata",
],
to: "/main/build/modules/gov",
},
{
from: [
"/main/modules/group/01_concepts",
"/main/modules/group/02_state",
"/main/modules/group/03_messages",
"/main/modules/group/04_events",
"/main/modules/group/05_client",
"/main/modules/group/06_metadata",
],
to: "/main/build/modules/group/",
},
{
from: [
"/main/modules/mint/01_concepts",
"/main/modules/mint/02_state",
"/main/modules/mint/03_begin_block",
"/main/modules/mint/04_params",
"/main/modules/mint/05_events",
"/main/modules/mint/06_client",
],
to: "/main/build/modules/mint/",
},
{
from: [
"/main/modules/nft/01_concepts",
"/main/modules/nft/02_state",
"/main/modules/nft/03_messages",
"/main/modules/nft/04_events",
],
to: "/main/build/modules/nft/",
},
{
from: [
"/main/modules/params/01_keeper",
"/main/modules/params/02_subspace",
],
to: "/main/build/modules/params/",
},
{
from: [
"/main/modules/slashing/01_concepts",
"/main/modules/slashing/02_state",
"/main/modules/slashing/03_messages",
"/main/modules/slashing/04_begin_block",
"/main/modules/slashing/05_hooks",
"/main/modules/slashing/06_events",
"/main/modules/slashing/07_tombstone",
"/main/modules/slashing/08_params",
"/main/modules/slashing/09_client",
],
to: "/main/build/modules/slashing/",
},
{
from: [
"/main/modules/staking/01_state",
"/main/modules/staking/02_state_transitions",
"/main/modules/staking/03_messages",
"/main/modules/staking/04_begin_block",
"/main/modules/staking/05_end_block",
"/main/modules/staking/06_hooks",
"/main/modules/staking/07_events",
"/main/modules/staking/08_params",
"/main/modules/staking/09_client",
],
to: "/main/build/modules/staking/",
},
{
from: [
"/main/modules/upgrade/01_concepts",
"/main/modules/upgrade/02_state",
"/main/modules/upgrade/03_events",
"/main/modules/upgrade/04_client",
],
to: "/main/build/modules/upgrade/",
},
{
from: ["/main/modules/capability", "/main/ecosystem"],
to: "/main/build/modules/auth",
},
{
from: ["/main/spec/circuit-breaker"],
to: "/main/build/modules/circuit",
},
{
from: ["/main/spec/reserve-pool"],
to: "/main/build/modules/distribution",
},
{
from: ["/main/run-node/cosmovisor"],
to: "/main/build/tooling/cosmovisor",
},
{
from: ["/main/migrations/pre-upgrade"],
to: "/main/build/building-apps/app-upgrade",
},
{
from: ["/main/tooling/depinject"],
to: "/main/build/packages/depinject",
},
{
from: ["/main/building-modules/autocli"],
to: "/main/develop/advanced/autocli",
},
],
},
],
],
};
module.exports = config;

21957
docs/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,54 +0,0 @@
{
"name": "cosmos-sdk-docs",
"version": "0.0.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"prestart": "./pre.sh",
"start": "docusaurus start",
"poststart": "./post.sh",
"prebuild": "./pre.sh",
"build": "docusaurus build",
"postbuild": "./post.sh",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "2.4.1",
"@docusaurus/plugin-client-redirects": "^2.4.1",
"@docusaurus/plugin-google-analytics": "^2.4.1",
"@docusaurus/preset-classic": "2.4.1",
"@mdx-js/react": "^1.6.22",
"@you54f/theme-github-codeblock": "^0.1.1",
"autoprefixer": "^10.4.15",
"clsx": "^1.2.1",
"postcss": "^8.4.28",
"postcss-import": "^15.1.0",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"tailwindcss": "^3.3.3"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "2.4.1"
},
"overrides": {
"trim": "0.0.3"
},
"browserslist": {
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
}
}

View File

@ -1,17 +1,16 @@
#!/usr/bin/env bash
find docs/build/modules ! -name '_category_.json' -type f -exec rm -rf {} +
rm -rf docs/build/tooling/01-cosmovisor.md
rm -rf docs/build/tooling/02-confix.md
rm -rf docs/build/tooling/03-hubl.md
rm -rf docs/build/packages/01-depinject.md
rm -rf docs/build/packages/02-collections.md
rm -rf docs/build/packages/03-orm.md
rm -rf docs/develop/advaced-concepts/17-autocli.md
rm -rf docs/user/run-node/04-rosetta.md
rm -rf docs/build/architecture
rm -rf docs/build/spec
rm -rf docs/build/rfc
rm -rf docs/develop/advanced/17-autocli.md
rm -rf docs/build/migrations/02-upgrading.md
rm -rf versioned_docs versioned_sidebars versions.json
rm -rf build/tooling/01-cosmovisor.md
rm -rf build/tooling/02-confix.md
rm -rf build/tooling/03-hubl.md
rm -rf build/packages/01-depinject.md
rm -rf build/packages/02-collections.md
rm -rf build/packages/03-orm.md
rm -rf develop/advaced-concepts/17-autocli.md
rm -rf user/run-node/04-rosetta.md
rm -rf build/architecture
rm -rf build/spec
rm -rf build/rfc
rm -rf develop/advanced/17-autocli.md
rm -rf build/migrations/02-upgrading.md

View File

@ -11,32 +11,32 @@ done
## Vesting is a submodule of auth, but we still want to display it in docs
## TODO to be removed in https://github.com/cosmos/cosmos-sdk/issues/9958
cp ../x/auth/vesting/README.md ./docs/build/modules/auth/1-vesting.md
cp ../x/auth/tx/README.md ./docs/build/modules/auth/2-tx.md
cp ../x/auth/vesting/README.md ./build/modules/auth/1-vesting.md
cp ../x/auth/tx/README.md ./build/modules/auth/2-tx.md
## Add modules page list
cat ../x/README.md | sed 's/\.\.\/docs\/build\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./docs/modules/README.md
cat ../x/README.md | sed 's/\.\.\/\/build\/building-modules\/README\.md/\/building-modules\/intro\.html/g' > ./modules/README.md
## Add tooling documentation
cp ../tools/cosmovisor/README.md ./docs/build/tooling/01-cosmovisor.md
cp ../tools/confix/README.md ./docs/build/tooling/02-confix.md
cp ../tools/hubl/README.md ./docs/build/tooling/03-hubl.md
wget -O docs/user/run-node/04-rosetta.md https://raw.githubusercontent.com/cosmos/rosetta/main/README.md
cp ../tools/cosmovisor/README.md ./build/tooling/01-cosmovisor.md
cp ../tools/confix/README.md ./build/tooling/02-confix.md
cp ../tools/hubl/README.md ./build/tooling/03-hubl.md
wget -O /user/run-node/04-rosetta.md https://raw.githubusercontent.com/cosmos/rosetta/main/README.md
## Add package documentation
cp ../client/v2/README.md ./docs/develop/advanced/17-autocli.md
cp ../depinject/README.md ./docs/build/packages/01-depinject.md
cp ../collections/README.md ./docs/build/packages/02-collections.md
cp ../orm/README.md ./docs/build/packages/03-orm.md
cp ../client/v2/README.md ./develop/advanced/17-autocli.md
cp ../depinject/README.md ./build/packages/01-depinject.md
cp ../collections/README.md ./build/packages/02-collections.md
cp ../orm/README.md ./build/packages/03-orm.md
## Add architecture documentation
cp -r ./architecture ./docs/build
cp -r ./architecture ./build
## Add spec documentation
cp -r ./spec ./docs/build
cp -r ./spec ./build
## Add rfc documentation
cp -r ./rfc ./docs/build/rfc
cp -r ./rfc ./build
## Add SDK migration documentation
cp -r ../UPGRADING.md ./docs/build/migrations/02-upgrading.md
cp -r ../UPGRADING.md ./build/migrations/02-upgrading.md

View File

@ -1,55 +0,0 @@
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation
The sidebars can be generated from the filesystem, or explicitly defined here.
Create as many sidebars as you want.
*/
// @ts-check
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
tutorialSidebar: [
{ type: "autogenerated", dirName: "." },
{
type: "category",
label: "Resources",
collapsed: false,
items: [
{
type: "link",
label: "Tutorials",
href: "https://tutorials.cosmos.network",
},
{
type: "link",
label: "SDK API Reference",
href: "https://pkg.go.dev/github.com/cosmos/cosmos-sdk",
},
{
type: "link",
label: "REST API Spec",
href: "https://docs.cosmos.network/swagger/",
},
{
type: "link",
label: "Awesome Cosmos",
href: "https://github.com/cosmos/awesome-cosmos",
},
{
type: "link",
label: "Support",
href: "https://github.com/orgs/cosmos/discussions",
},
],
},
],
};
module.exports = sidebars;

View File

@ -1,32 +0,0 @@
/*
Copied from https://github.com/ignite/cli/blob/develop/docs/src/css/base.css
*/
@layer base {
html {
@apply font-inter;
font-feature-settings: 'kern', 'liga', 'calt', 'zero' 0;
-webkit-font-feature-settings: 'kern', 'liga', 'calt', 'zero' 0;
text-size-adjust: 100%;
-moz-osx-font-smoothing: grayscale;
font-smoothing: antialiased;
font-variant-ligatures: contextual common-ligatures;
font-kerning: normal;
text-rendering: optimizeLegibility;
@supports (font-variation-settings: normal) {
@apply font-intervar
}
}
*,
*::before,
*::after {
box-sizing: border-box;
margin: 0;
}
svg { display: inline; }
::selection{}
}

View File

@ -1,514 +0,0 @@
/*
Slighlty modified version of https://github.com/ignite/cli/blob/develop/docs/src/css/custom.css
*/
@import "tailwindcss/base";
@import "./fonts.css";
@import "./base.css";
@import "tailwindcss/components";
@import "tailwindcss/utilities";
/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #5064fb;
--ifm-color-primary-dark: theme(colors.gray.1000);
--ifm-color-primary-darker: theme(colors.gray.1000);
--ifm-color-primary-darkest: theme(colors.gray.1000);
--ifm-color-primary-light: theme(colors.gray.1000);
--ifm-color-primary-lighter: theme(colors.gray.1000);
--ifm-color-primary-lightest: theme(colors.gray.1000);
--ifm-code-font-size: 95%;
--ifm-breadcrumb-item-background-active: transparent;
--ifm-breadcrumb-padding-horizontal: 0;
--ifm-list-paragraph-margin: 0;
--ifm-spacing-horizontal: theme(spacing.7);
--ifm-blockquote-border-color: theme(colors.gray.1000);
--ifm-menu-link-padding-vertical: 0.6rem;
--ifm-background-color: theme(colors.gray.0);
--ifm-footer-link-color: var(--ifm-font-color-base);
--ifm-menu-link-sublist-icon: url("~/img/ico-chevron.svg");
--docsearch-searchbox-background: #f7f7f7;
--docsearch-modal-background: theme(colors.card) !important;
--ifm-navbar-height: 5.563rem;
--ifm-navbar-sidebar-width: 100vw;
--docsearch-highlight-color: theme(colors.fg) !important;
--docsearch-searchbox-shadow: inset 0 0 0 1px var(--docsearch-primary-color);
/* temp: local search bar */
--aa-primary-color-rgb: 0, 0, 0;
@media screen and (prefers-reduced-motion) {
transition: ;
}
--ifm-menu-color-background-active: none;
--ifm-menu-color-background-hover: none;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}
/* For readability concerns, you should choose a lighter palette in dark mode. */
html[data-theme="dark"] {
--ifm-color-primary: theme(colors.gray.0);
--ifm-color-primary-dark: #e6e6e6;
--ifm-color-primary-darker: #d9d9d9;
--ifm-color-primary-darkest: #b3b3b3;
--ifm-color-primary-light: theme(colors.gray.0);
--ifm-color-primary-lighter: theme(colors.gray.0);
--ifm-color-primary-lightest: theme(colors.gray.0);
--ifm-background-color: theme(colors.gray.1000);
--docusaurus-highlighted-code-line-bg: theme(colors.inactive);
--docsearch-modal-background: theme(colors.gray.1000) !important;
--docsearch-highlight-color: theme(colors.inactiveLight) !important;
--docsearch-hit-background: theme(colors.lightfg) !important;
--docsearch-searchbox-shadow: inset 0 0 0 1px var(--docsearch-primary-color);
--docsearch-key-gradient: linear-gradient(
-26.5deg,
#5d5d5d,
#3c3c3c
) !important;
--docsearch-key-shadow: inset 0 -2px 0 0 #353535, inset 0 0 1px 1px #7a7a7b,
0 2px 2px 0 rgba(45, 45, 45, 0.3) !important;
}
html {
@apply bg-docusaurusBgColor;
/* Banner */
#__docusaurus > div[role="banner"] {
@apply bg-gray-30 text-gray-1000 font-normal;
a {
@apply no-underline w-full text-2;
}
}
/* MAINNAV */
.navbar {
@apply py-2 h-auto border-b border-b-docusaurusColorBorder shadow-none bg-docusaurusBgColor;
&__toggle {
@apply bg-card rounded-s h-8 w-8 flex justify-center items-center;
@media (min-width: 997px) {
@apply hidden;
}
}
&__brand {
& + * {
@apply ml-auto;
}
}
&__link--active {
@apply text-muted;
}
&__items:not(:last-child) {
@apply justify-between;
@media (min-width: 997px) {
@apply justify-start px-3;
}
button {
@apply order-2 mr-0;
}
}
&__items--right > :last-child {
@apply right-8.5;
}
}
&[data-theme="dark"] .navbar__item {
@apply text-mutedLight;
}
&[data-theme="dark"] .navbar__toggle {
@apply bg-fg;
}
.github-icon {
@apply hover:opacity-50;
}
/* SEARCHBAR */
/* algolia */
.DocSearch {
&-Hits mark {
@apply text-docusaurusColorBase;
}
&-Button {
@apply text-inactive rounded-sm h-8 w-8 bg-card justify-center mr-3;
@media (min-width: 997px) {
@apply w-auto justify-between;
}
.DocSearch-Search-Icon {
@apply text-docusaurusColorBase;
}
.DocSearch-Button-Keys {
@apply hidden;
}
.DocSearch-Button-Placeholder {
@apply pr-10;
}
}
&-Logo path {
@apply fill-docusaurusColorBase;
}
}
.navbar-sidebar {
@apply w-full;
&__brand {
@apply px-6 h-auto;
}
&__item {
@apply px-6 w-full;
}
&__back {
@apply px-0 hidden;
}
&__close {
@apply bg-gray-1000 rounded-s h-8 w-8 flex justify-center items-center ml-0;
& > svg > g {
@apply stroke-gray-0;
}
}
}
&[data-theme="dark"] .navbar-sidebar {
@apply bg-gray-1000;
&__brand {
@apply shadow-none relative;
&::after {
content: "";
@apply absolute block h-px bg-linkHover bottom-0 right-3 left-0 mx-6;
}
}
&__close {
@apply bg-gray-0;
& > svg > g {
@apply stroke-gray-1000;
}
}
}
&[data-theme="dark"] .DocSearch-Modal {
@apply bg-gray-1000;
}
&[data-theme="dark"] .DocSearch-Footer {
@apply bg-gray-1000;
}
&[data-theme="dark"] .DocSearch-Button {
@apply bg-fg text-inactiveLight;
}
&[data-theme="dark"] .DocSearch-Button-Key {
@apply text-inactiveLight border-inactiveLight;
}
/* BREADCRUMBS */
.breadcrumbs__item {
&:first-child {
& > a {
&::after {
content: "Docs";
}
& > svg {
@apply hidden;
}
}
}
&:not(:last-child)::after {
content: ">";
@apply bg-none;
}
}
.theme-doc-breadcrumbs {
@media (min-width: 997px) {
@apply pt-[calc(theme(spacing.7)-1rem)];
}
}
.theme-doc-toc-mobile {
@apply bg-card px-6 py-5.5 pb-0 rounded;
& > button {
@apply p-0 pb-5.5 flex justify-between;
&::after {
@apply order-last ml-5;
background-image: var(--ifm-menu-link-sublist-icon);
background-size: 70%;
}
}
& ul li {
@apply my-5 mx-0;
}
}
&[data-theme="dark"] .theme-doc-toc-mobile {
@apply bg-fg;
}
/* SIDEBAR */
.theme-doc-sidebar-container {
@media (min-width: 997px) {
@apply ml-4 border-r border-r-docusaurusColorBorder;
}
& > div:first-child > a {
@apply m-0;
}
}
&[data-theme="dark"] .theme-doc-sidebar-menu .menu__list::before {
@apply bg-inactiveLight;
}
.theme-doc-sidebar-menu {
@apply font-normal;
.menu__list {
@apply relative pl-0;
&::before {
content: "";
@apply absolute block left-3 top-0 h-full w-[2px] bg-border;
}
ul::before {
@apply hidden;
}
}
.menu__link {
@apply pl-0 pr-5;
&--active:not(.menu__link--sublist) {
@apply text-docusaurusColorBase font-medium;
}
}
li li {
@apply pl-7;
.menu__link--active:not(.menu__link--sublist) {
@apply relative text-docusaurusColorBase font-medium;
&::before {
content: "";
@apply absolute block left-0 top-0 h-full w-[2px] bg-docusaurusColorBase;
@apply -left-[calc(theme(space.7)-theme(space.3))];
}
}
}
li li li {
@apply pl-5;
}
li li li .menu__link--active:not(.menu__link--sublist)::before {
@apply -left-[calc(theme(space.5)*1+theme(space.7)-theme(space.3))];
}
li li li li .menu__link--active:not(.menu__link--sublist)::before {
@apply -left-[calc(theme(space.5)*2+theme(space.7)-theme(space.3))];
}
li li li li li .menu__link--active:not(.menu__link--sublist)::before {
@apply -left-[calc(theme(space.5)*3+theme(space.7)-theme(space.3))];
}
li li li li li li .menu__link--active:not(.menu__link--sublist)::before {
@apply -left-[calc(theme(space.5)*4+theme(space.7)-theme(space.3))];
}
li li li li li li li .menu__link--active:not(.menu__link--sublist)::before {
@apply -left-[calc(theme(space.5)*5+theme(space.7)-theme(space.3))];
}
}
&[data-theme="dark"] .menu__link {
@apply text-mutedLight;
}
.theme-doc-sidebar-item-link .menu__link[target="_blank"] {
&::after {
content: "\2197";
@apply ml-1;
}
}
.menu__link {
@apply text-muted;
&:hover {
text-shadow: 0.1px 0.1px 0 var(--ifm-font-color-base),
-0.1px -0.1px 0 var(--ifm-font-color-base),
0.1px -0.1px 0 var(--ifm-font-color-base),
-0.1px 0.1px 0 var(--ifm-font-color-base),
-0.1px 0 0 var(--ifm-font-color-base),
0.1px 0 0 var(--ifm-font-color-base),
0 0.1px 0 var(--ifm-font-color-base),
0 -0.1px 0 var(--ifm-font-color-base);
@apply text-docusaurusColorBase;
}
& > svg {
@apply hidden;
}
}
.menu__link--sublist-caret {
@apply flex;
&::after {
background-size: 16px;
background-repeat: no-repeat;
@apply order-first ml-0 mr-4;
}
}
.menu__list-item--collapsed .menu__link--sublist:after,
.menu__list-item--collapsed .menu__caret:before {
transform: rotateZ(0);
}
.menu__caret,
li li .menu__link--sublist-caret::after {
@apply hidden;
}
/* TOC */
.table-of-contents__link:hover,
.table-of-contents__link--active {
text-shadow: 0.1px 0.1px 0 var(--ifm-font-color-base),
-0.1px -0.1px 0 var(--ifm-font-color-base),
0.1px -0.1px 0 var(--ifm-font-color-base),
-0.1px 0.1px 0 var(--ifm-font-color-base),
-0.1px 0 0 var(--ifm-font-color-base),
0.1px 0 0 var(--ifm-font-color-base), 0 0.1px 0 var(--ifm-font-color-base),
0 -0.1px 0 var(--ifm-font-color-base);
}
/* RELATED ARTICLES */
&[data-theme="dark"] .pagination-nav > a {
@apply bg-fg;
}
.pagination-nav {
@apply pb-7 mt-9;
& > a {
box-shadow: 0px 0px 80px rgba(0, 0, 0, 0.07);
@apply border-transparent rounded pb-8.5 col-span-2 pt-6 px-6 hover:shadow-none;
@media (min-width: 997px) {
@apply col-span-1;
}
}
.pagination-nav {
&__link--next {
@apply text-left;
@media (min-width: 997px) {
@apply text-right;
}
}
&__sublabel {
@apply mb-3.5 text-gray-1000 dark:text-docusaurusColorBase text-3;
}
&__label {
@apply text-4 font-semibold;
}
}
}
/* FOOTER */
.footer {
background-color: var(--ifm-background-color);
@apply border-t border-t-docusaurusColorBorder pt-10 mb-10;
&__link-item {
@apply hover:underline;
}
&__bottom {
margin: 0 calc(var(--ifm-spacing-horizontal) * -1);
}
&__copyright {
@apply text-center mt-9 text-2;
}
}
.footer__col:not(:first-child) {
@apply basis-1/2;
@media (min-width: 997px) {
@apply basis-0;
}
}
.footer__col:first-child .footer__title {
@apply hidden;
}
.footer__link-item {
& > svg {
@apply hidden;
}
}
.theme-back-to-top-button {
@apply rotate-180;
&::after {
@apply w-1/2;
}
}
/* MARKDOWN */
.theme-code-block {
@apply font-jetbrain mt-3;
}
.markdown {
--ifm-heading-vertical-rhythm-bottom: 1;
--ifm-h1-vertical-rhythm-bottom: 1;
}
.theme-doc-markdown {
@apply mt-7 pb-8 border-b border-b-border;
h1 {
@apply text-7 font-bold leading-10 tracking-tight;
}
h2 {
@apply text-6 font-bold leading-9 tracking-tight;
}
h3 {
@apply text-4 font-semibold leading-8 tracking-tight;
}
h4 {
@apply text-3 font-semibold leading-7 tracking-tight;
}
h5 {
@apply text-3 font-semibold leading-6 tracking-wide;
}
p {
@apply leading-relaxed;
}
p,
ul,
ol,
blockquote {
@apply text-[1rem];
}
code {
@apply border-0 px-3;
}
blockquote {
@apply my-7;
}
a {
@apply no-underline hover:underline;
color: var(--ifm-color-primary);
}
ol,
ul {
@apply my-6;
}
ul li {
@apply relative pl-6 mb-4 before:absolute before:block before:w-[4px] before:h-[4px] before:bg-current before:left-0 before:top-[calc(1em/2)];
}
ul li li {
@apply last:mb-6 before:border before:border-current before:bg-transparent;
}
li:last-child li {
@apply last:mb-0;
}
ol {
list-style-type: none;
counter-reset: item;
& > li {
@apply relative pl-8 mb-5.5;
&::before {
counter-increment: item;
content: counters(item, ".", decimal-leading-zero) ".";
@apply absolute flex left-0 top-[.2rem] text-3 font-semibold tracking-tight;
}
}
}
ol ol {
counter-reset: subitem;
& > li {
&::before {
counter-increment: subitem;
content: counters(subitem, ".", decimal-leading-zero) ".";
}
}
}
li {
& > ul,
& > ol {
@apply my-5;
}
}
}
}

View File

@ -1,64 +0,0 @@
/*
FONT FAMILY GROUPS
*/
/*
Copied from https://github.com/ignite/cli/blob/develop/docs/src/css/fonts.css
*/
/* Inter */
@font-face {
font-family: "Inter";
font-style: normal;
font-weight: 400;
font-display: swap;
src: url("~/static/fonts/inter/Inter-Regular.woff2?v=3.19") format("woff2"),
url("~/static/fonts/inter/Inter-Regular.woff?v=3.19") format("woff");
}
@font-face {
font-family: "Inter";
font-style: normal;
font-weight: 500;
font-display: swap;
src: url("~/static/fonts/inter/Inter-Medium.woff2?v=3.19") format("woff2"),
url("~/static/fonts/inter/Inter-Medium.woff?v=3.19") format("woff");
}
@font-face {
font-family: "Inter";
font-style: normal;
font-weight: 700;
font-display: swap;
src: url("~/static/fonts/inter/Inter-Bold.woff2?v=3.19") format("woff2"),
url("~/static/fonts/inter/Inter-Bold.woff?v=3.19") format("woff");
}
@font-face {
font-family: "Inter";
font-style: normal;
font-weight: 900;
font-display: swap;
src: url("~/static/fonts/inter/Inter-Black.woff2?v=3.19") format("woff2"),
url("~/static/fonts/inter/Inter-Black.woff?v=3.19") format("woff");
}
/* Inter var */
@font-face {
font-family: "Inter var";
font-weight: 100 900;
font-display: swap;
font-style: oblique 0deg 10deg;
src: url("~/static/fonts/intervar/Inter.var.woff2?v=3.19") format("woff2");
}
/* JetBrains Mono */
@font-face {
font-family: "JetBrains Mono";
font-weight: normal;
font-style: normal;
src: url("~/static/fonts/jetbrainsmono/JetBrainsMono-Regular.woff2")
format("woff2");
}

View File

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Some files were not shown because too many files have changed in this diff Show More