Skip to content

Commit

Permalink
Revamp of the documentation (#1)
Browse files Browse the repository at this point in the history 
* wip

* Update glossary

* review updates

* update actions

* remove path

* Update deploy-docs.yml
  • Loading branch information
@samricotta
samricotta committed Jun 11, 2023
1 parent c90c6d6 commit eb470d3
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 217 deletions.
6 changes: 3 additions & 3 deletions docs/develop/_category_.json
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Develop",
"position": 0,
"link": null
"label": "Develop",
"position": 0,
"link": null
}
3 changes: 2 additions & 1 deletion docs/integrate/architecture/PROCESS.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
1. Copy the `adr-template.md` file. Use the following filename pattern: `adr-next_number-title.md`
2. Create a draft Pull Request if you want to get an early feedback.
3. Make sure the context and a solution is clear and well documented.
4. Create a Pull Request to propose a new ADR.
4. Add an entry to a list in the [README](README.md) file.
5. Create a Pull Request to propose a new ADR.

## What is an ADR?

Expand Down
228 changes: 15 additions & 213 deletions docusaurus.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@

const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
const customVersionPlugin = require('./custom-version-plugin');

// const lastVersion = "v0.47";
const lastVersion = "current";

/** @type {import('@docusaurus/types').Config} */
const config = {
Expand Down Expand Up @@ -39,12 +40,7 @@ const config = {
docs: {
sidebarPath: require.resolve("./sidebars.js"),
routeBasePath: "/",
lastVersion: "current",
versions: {
current: {
label: "Main"
},
},
lastVersion: lastVersion,
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
Expand Down Expand Up @@ -110,6 +106,18 @@ const config = {
position: "right",
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",
},
],
},
],
},
Expand Down Expand Up @@ -210,219 +218,13 @@ const config = {
},
};
},
customVersionPlugin,
[
"@docusaurus/plugin-google-analytics",
{
trackingID: "UA-51029217-2",
anonymizeIP: true,
},
],
[
"@docusaurus/plugin-client-redirects",
{
fromExtensions: ["html"],
toExtensions: ["html"],
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: "/integrate/modules/auth",
},
{
from: "/main/modules/auth/05_vesting",
to: "/integrate/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: "/integrate/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: "/integrate/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: "/integrate/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: "/integrate/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: "/integrate/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: "/integrate/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: "/integrate/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: "/integrate/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: "/integrate/modules/mint/",
},
{
from: [
"/main/modules/nft/01_concepts",
"/main/modules/nft/02_state",
"/main/modules/nft/03_messages",
"/main/modules/nft/04_events",
],
to: "/integrate/modules/nft/",
},
{
from: [
"/main/modules/params/01_keeper",
"/main/modules/params/02_subspace",
],
to: "/integrate/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: "/integrate/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: "/integrate/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/integrate/modules/upgrade/",
},
{
from: ["/main/modules/capability", "/main/ecosystem"],
to: "/integrate/modules",
},
{
from: ["/main/spec/circuit-breaker"],
to: "/integrate/modules/circuit",
},
{
from: ["/main/spec/reserve-pool"],
to: "/integrate/modules/distribution",
},
{
from: ["/main/run-node/cosmovisor"],
to: "/integrate/tooling/cosmovisor",
},
{
from: ["/main/migrations/pre-upgrade"],
to: "/integrate/building-apps/app-upgrade",
},
{
from: ["/main/tooling/depinject"],
to: "/integrate/libraries/depinject",
},
],
},
],
],
};

Expand Down

0 comments on commit eb470d3

Please sign in to comment.