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

Commit

Permalink
doc: duplicated documentation removed (#603)
Browse files Browse the repository at this point in the history
  • Loading branch information
hanchon authored Sep 29, 2021
1 parent f7d6d06 commit 1894d22
Show file tree
Hide file tree
Showing 79 changed files with 3 additions and 42,692 deletions.
29 changes: 0 additions & 29 deletions .github/workflows/build-docs.yml

This file was deleted.

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

### Updating Documentation

If you open a PR on Ethermint, it is mandatory to update the relevant documentation in `/docs`.

- 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.
- 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.
- If your changes relate to a module, then be sure to update the module's spec in `x/moduleName/docs/spec/`.

When writing documentation, follow the [Documentation Writing Guidelines](./docs/DOC_WRITING_GUIDELINES.md).

## Forking

Go requires code to live under absolute paths, and this requirement complicates forking.
Expand Down
46 changes: 2 additions & 44 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -215,16 +215,8 @@ else
@echo "solcjs already installed; skipping..."
endif

docs-tools:
ifeq (, $(shell which yarn))
@echo "Installing yarn..."
@npm install -g yarn
else
@echo "yarn already installed; skipping..."
endif

tools: tools-stamp
tools-stamp: contract-tools docs-tools proto-tools statik runsim
tools-stamp: contract-tools proto-tools statik runsim
# Create dummy file to satisfy dependency and avoid
# rebuilding when this Makefile target is hit twice
# in a row.
Expand All @@ -234,13 +226,7 @@ tools-clean:
rm -f $(RUNSIM)
rm -f tools-stamp

docs-tools-stamp: docs-tools
# Create dummy file to satisfy dependency and avoid
# rebuilding when this Makefile target is hit twice
# in a row.
touch $@

.PHONY: runsim statik tools contract-tools docs-tools proto-tools tools-stamp tools-clean docs-tools-stamp
.PHONY: runsim statik tools contract-tools proto-tools tools-stamp tools-clean

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

# Start docs site at localhost:8080
docs-serve:
@cd docs && \
yarn && \
yarn run serve

# Build the site into docs/.vuepress/dist
build-docs:
@$(MAKE) docs-tools-stamp && \
cd docs && \
yarn && \
yarn run build

# This builds a docs site for each branch/tag in `./docs/versions`
# and copies each site to a version prefixed path. The last entry inside
# the `versions` file will be the default root index.html.
build-docs-versioned:
@$(MAKE) docs-tools-stamp && \
cd docs && \
while read -r branch path_prefix; do \
(git checkout $${branch} && npm install && VUEPRESS_BASE="/$${path_prefix}/" npm run build) ; \
mkdir -p ~/output/$${path_prefix} ; \
cp -r .vuepress/dist/* ~/output/$${path_prefix}/ ; \
cp ~/output/$${path_prefix}/index.html ~/output ; \
done < versions ;

.PHONY: docs-serve build-docs build-docs-versioned

###############################################################################
### Tests & Simulation ###
###############################################################################
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Or check out the latest [release](https://github.com/tharsis/ethermint/releases)

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).

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

## Community

Expand Down
Loading

0 comments on commit 1894d22

Please sign in to comment.