search

eosnetworkfoundation / mandel

Obsolete. Use https://github.com/AntelopeIO/leap instead.
Other
87 stars 30 forks source link

documentation fixes to power developer doc portal #748

Closed ericpassmore closed 2 years ago

ericpassmore commented 2 years ago

Summary

Impacted files: markdown files under docs and under tutorial

The developer documentation portal is powered by markdown files. These files are parsed to create a nice looking web site. We use MDX as the parsing engine. MDX requires all html tags are closed. We went through all the files removing unneeded <hr> tags, enclosing angle brackets in quotes, and closing img tags.

Many times we found documentation pointing to old repositories that had not been updated in years. We updated the links and pointed to repositories that are better maintained.

We made sure links to the documentation portal did not leak back to older, previous versions.

We found relative links that no longer existed. We made sure to point the links to best location. Sometimes the links broke because were missing a key file extension. We made sure to add back the file extenstion.

Note: This is essentially a no-op; however summarizing here for anyone following the commit history. Glossary and Protocol Guides were added and removed during the course of development. We had added a Glossary and Protocol Guides , and we decided to utilize the welcome repository as the source for both.

commit ba20420c42f2f8bbf3396102d3ac22261028af30 Author: Eric Passmore eric.passmore@gmail.com Date: Thu Aug 4 12:46:52 2022 -0700

Testsnets anchor link was not working rm it

commit d5de39dbbe250d2a9878c82de990c086c3b7b122 Author: Eric Passmore eric.passmore@gmail.com Date: Thu Aug 4 10:27:42 2022 -0700

adding missing .md ext

commit 9dbb885d2eb308e60a2db909c9aed7b5dcb4289a Author: Eric Passmore eric.passmore@gmail.com Date: Thu Aug 4 10:24:49 2022 -0700

found another eos.io reference to replace

commit 6a10c44b5863552c85c283db5b6d24e84b84f2cf Author: Eric Passmore eric.passmore@gmail.com Date: Thu Aug 4 08:47:02 2022 -0700

moved away from eos testnet

commit 023c8e50724b766b0b9c8ce859d106101bc90fc8 Merge: 9d486ab51 6514a7d63 Author: Eric Passmore eric.passmore@gmail.com Date: Thu Aug 4 08:33:00 2022 -0700

Merge remote-tracking branch 'origin/main' into documentation-fixes

Fixing docs by removing eosio references, need resync with main to catch merge issues early

commit 9d486ab51aa399a4e5c7a038c19531071a88e900 Author: Eric Passmore eric.passmore@gmail.com Date: Tue Aug 2 08:19:36 2022 -0700

updated protocol-guides links to include number

commit 907d9e2af8796087ba830f10f53df0063d0a621d Author: Eric Passmore eric.passmore@gmail.com Date: Fri Jul 29 16:23:41 2022 -0700

removed general_info replaced by welcome repository markdown

commit 07efa3fb831ef2d57f68be0ef3aa21e28c346a80 Merge: 056239ccc d36ca7a52 Author: Eric Passmore eric.passmore@gmail.com Date: Fri Jul 29 07:10:24 2022 -0700

merging with upstream/main keeping up to date

commit 056239cccb5e3337b5598364190cd4dc9d16a281 Merge: b921bdf98 b378866ef Author: Eric Passmore eric.passmore@gmail.com Date: Tue Jul 26 17:08:43 2022 -0700

Merge remote-tracking branch 'refs/remotes/origin/documentation-fixes' into documentation-fixes

Note pulled in "changes to lower bound description" 766C6164
Resolved Conflicts No Changes:
    docs/general_info/glossary.md
    docs/general_info/protocol-guides/consensus_protocol.md
    docs/general_info/protocol-guides/network_peer_protocol.md
    docs/general_info/protocol-guides/transactions_protocol.md
Changes to be committed:
    modified:   docs/general_info/protocol-guides/accounts_and_permissions.md
    modified:   libraries/chain/include/eosio/chain/webassembly/interface.hpp

commit b921bdf987c0206b6704968eaca3bc05c505d469 Author: Eric Passmore eric.passmore@gmail.com Date: Tue Jul 26 16:44:25 2022 -0700

removed eos.io from markdown

- Added docs/general_info/glossary.md
- Added docs/general_info/protocol-guides
     - overview only for accounts_and_permissions.md
     - overview only for transactions_protocol.md
     - overview only for network_peer_protocol.md
     - overview only for consensus_protocol.md
- Updated glossary.md to relative path (no more eos.io)
- Fixed links adding missing .md extenstion
- Updated protocol-guides to relative path (no more eos.io)
- Included BiosBoot tutorial on main document portal
- Fixed or removed broken links inside newly added glossary, guides, and tutorials

Note: squashed commits on branch down to single commit, less noise, easier to cherry-pick

commit b378866eff4be5cd3986c88a6d6ff39a802fee57 Author: Eric Passmore eric.passmore@gmail.com Date: Tue Jul 26 15:36:42 2022 -0700

adding back more missing .md extenstions, and simplying bios-boot-tutorial

commit 2f7c0e65cbf360ba13102c8a5341714c4ce1159d Author: Eric Passmore eric.passmore@gmail.com Date: Tue Jul 26 15:14:16 2022 -0700

fixing more missing .md ext

commit 07b1f16962921acdd35d24c87e6a87378c7a10fc Author: Eric Passmore eric.passmore@gmail.com Date: Tue Jul 26 15:03:06 2022 -0700

updated with .md ext

commit 002b01ddc81e67d09dba40fae9cc2303b4efed7b Author: Eric Passmore eric.passmore@gmail.com Date: Tue Jul 26 14:29:33 2022 -0700

updated formate for glossary links to include .md

commit bf344ae16c76ca1109672b8e9cccc5a69527e3d3 Merge: 3bbb956b5 0cb196b7f Author: Eric Passmore eric.passmore@gmail.com Date: Tue Jul 26 08:48:05 2022 -0700

merging main into documentation-fixes, after removing eso.io references adding glossary and guides

commit 3bbb956b524267c788dd9614011abeda1be96b93 Author: Eric Passmore eric.passmore@gmail.com Date: Tue Jul 26 08:47:12 2022 -0700

remove eos.io references, added glossary, guides