Skip to content
This repository was archived by the owner on Apr 4, 2024. It is now read-only.

Commit 1894d22

Browse files
authored
doc: duplicated documentation removed (#603)
1 parent f7d6d06 commit 1894d22

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+3
-42692
lines changed

.github/workflows/build-docs.yml

Lines changed: 0 additions & 29 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -106,16 +106,6 @@ items. In addition, use the following review explanations:
106106
- If you sat down with the PR submitter and did a pairing review, add this information in the `Approval` or your PR comments.
107107
- If you are only making "surface level" reviews, submit any notes as `Comments` without adding a review.
108108

109-
### Updating Documentation
110-
111-
If you open a PR on Ethermint, it is mandatory to update the relevant documentation in `/docs`.
112-
113-
- If your change relates to the core SDK (baseapp, store, ...), be sure to update the content in `docs/basics/`, `docs/core/` and/or `docs/building-modules/` folders.
114-
- If your changes relate to the core of the CLI (not specifically to module's CLI/Rest), then modify the content in the `docs/run-node/` folder.
115-
- If your changes relate to a module, then be sure to update the module's spec in `x/moduleName/docs/spec/`.
116-
117-
When writing documentation, follow the [Documentation Writing Guidelines](./docs/DOC_WRITING_GUIDELINES.md).
118-
119109
## Forking
120110

121111
Go requires code to live under absolute paths, and this requirement complicates forking.

Makefile

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -215,16 +215,8 @@ else
215215
@echo "solcjs already installed; skipping..."
216216
endif
217217

218-
docs-tools:
219-
ifeq (, $(shell which yarn))
220-
@echo "Installing yarn..."
221-
@npm install -g yarn
222-
else
223-
@echo "yarn already installed; skipping..."
224-
endif
225-
226218
tools: tools-stamp
227-
tools-stamp: contract-tools docs-tools proto-tools statik runsim
219+
tools-stamp: contract-tools proto-tools statik runsim
228220
# Create dummy file to satisfy dependency and avoid
229221
# rebuilding when this Makefile target is hit twice
230222
# in a row.
@@ -234,13 +226,7 @@ tools-clean:
234226
rm -f $(RUNSIM)
235227
rm -f tools-stamp
236228

237-
docs-tools-stamp: docs-tools
238-
# Create dummy file to satisfy dependency and avoid
239-
# rebuilding when this Makefile target is hit twice
240-
# in a row.
241-
touch $@
242-
243-
.PHONY: runsim statik tools contract-tools docs-tools proto-tools tools-stamp tools-clean docs-tools-stamp
229+
.PHONY: runsim statik tools contract-tools proto-tools tools-stamp tools-clean
244230

245231
go.sum: go.mod
246232
echo "Ensure dependencies have not been modified ..." >&2
@@ -265,34 +251,6 @@ godocs:
265251
@echo "--> Wait a few seconds and visit http://localhost:6060/pkg/github.com/tharsis/ethermint/types"
266252
godoc -http=:6060
267253

268-
# Start docs site at localhost:8080
269-
docs-serve:
270-
@cd docs && \
271-
yarn && \
272-
yarn run serve
273-
274-
# Build the site into docs/.vuepress/dist
275-
build-docs:
276-
@$(MAKE) docs-tools-stamp && \
277-
cd docs && \
278-
yarn && \
279-
yarn run build
280-
281-
# This builds a docs site for each branch/tag in `./docs/versions`
282-
# and copies each site to a version prefixed path. The last entry inside
283-
# the `versions` file will be the default root index.html.
284-
build-docs-versioned:
285-
@$(MAKE) docs-tools-stamp && \
286-
cd docs && \
287-
while read -r branch path_prefix; do \
288-
(git checkout $${branch} && npm install && VUEPRESS_BASE="/$${path_prefix}/" npm run build) ; \
289-
mkdir -p ~/output/$${path_prefix} ; \
290-
cp -r .vuepress/dist/* ~/output/$${path_prefix}/ ; \
291-
cp ~/output/$${path_prefix}/index.html ~/output ; \
292-
done < versions ;
293-
294-
.PHONY: docs-serve build-docs build-docs-versioned
295-
296254
###############################################################################
297255
### Tests & Simulation ###
298256
###############################################################################

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Or check out the latest [release](https://github.com/tharsis/ethermint/releases)
6363

6464
To learn how the Ethermint works from a high-level perspective, go to the [Introduction](https://ethermint.dev/intro/overview.html) section from the documentation. You can also check the instructions to [Run a Node](https://ethermint.dev/quickstart/run_node.html).
6565

66-
For more, please refer to the [Ethermint Docs](./docs/), which are also hosted on [ethermint.dev](https://ethermint.dev/).
66+
For an example on how Ethermint can be used on any cosmos chain, please refer to [Evmos](https://www.github.com/tharsis/evmos)
6767

6868
## Community
6969

0 commit comments

Comments
 (0)