docs: template for spec and initial files (celestiaorg#1856)

* docs: add template

Co-authored-by: Sanaz Taheri <[email protected]>

* add initial files and their link

* fix: remove dead link

* docs: remove todo

Co-authored-by: Rootul P <[email protected]>

* docs: remove individual directories per state machine module

* fix: support for mdbook by remove things w/o a link

* chore: add state machine modules to the readme

* chore: better mdbooks structure

* chore: add all standard cosmos-sdk modules as well

* chore: add missing link in readme

* chore: add missing link in the readme

* typo

Co-authored-by: Rootul P <[email protected]>

---------

Co-authored-by: Sanaz Taheri <[email protected]>
Co-authored-by: Rootul P <[email protected]>

specs/src/README.md

@@ -4,7 +4,14 @@
   - [Data Structures](./specs/data_structures.md)
   - [Consensus](./specs/consensus.md)
   - [Block Proposer](./specs/block_proposer.md)
+  - [Block Validity Rules](./specs/block_validity_rules.md)
   - [Networking](./specs/networking.md)
   - [Public-Key Cryptography](./specs/public_key_cryptography.md)
 - [Rationale](./rationale/index.md)
   - [Data Square Layout](./rationale/data_square_layout.md)
+- [State Machine Modules](./specs/state_machine_modules.md)
+  - [blob](../../x/blob/README.md)
+  - [qgb](../../x/qgb/README.md)
+  - [mint](../../x/mint/README.md)
+  - [paramfilter](../../x/paramfilter/README.md)
+  - [upgrade](../../x/upgrade/README.md)

specs/src/SUMMARY.md

@@ -6,7 +6,14 @@
   - [Data Structures](./specs/data_structures.md)
   - [Consensus](./specs/consensus.md)
   - [Block Proposer](./specs/block_proposer.md)
+  - [Block Validity Rules](./specs/block_validity_rules.md)
   - [Networking](./specs/networking.md)
   - [Public-Key Cryptography](./specs/public_key_cryptography.md)
 - [Rationale](./rationale/index.md)
   - [Data Square Layout](./rationale/data_square_layout.md)
+- [State Machine Modules](./specs/state_machine_modules.md)
+  - [blob](../../x/blob/README.md)
+  - [qgb](../../x/qgb/README.md)
+  - [mint](../../x/mint/README.md)
+  - [paramfilter](../../x/paramfilter/README.md)
+  - [upgrade](../../x/upgrade/README.md)

specs/src/specs/block_validity_rules.md

@@ -0,0 +1 @@
+# Block Validity Rules

specs/src/specs/state_machine_modules.md

@@ -0,0 +1,30 @@
+# State Machine Modules
+
+Celestia app is built using the cosmos-sdk, and follows standard cosmos-sdk module structure.
+
+## `celestia-app` Specific Modules
+
+- [blob](../../../x/blob/README.md)
+- [qgb](../../../x/qgb/README.md)
+- [mint](../../../x/mint/README.md)
+- [paramfilter](../../../x/paramfilter/README.md)
+- [upgrade](../../../x/upgrade/README.md)
+
+## Standard `cosmos-sdk` Modules
+
+- [auth](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/auth/spec/README.md)
+- [authz](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/authz/spec/README.md)
+- [bank](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/bank/spec/README.md)
+- [capability](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/capability/spec/README.md)
+- [crisis](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/crisis/spec/README.md)
+- [distribution](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/distribution/spec/README.md)
+- [evidence](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/evidence/spec/README.md)
+- [feegrant](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/feegrant/spec/README.md)
+- [genutil](https://github.com/celestiaorg/cosmos-sdk/tree/v1.14.0-sdk-v0.46.11/x/genutil) (no spec)
+- [gov](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/gov/spec/README.md)
+- [params](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/params/spec/README.md)
+- [ibc](https://github.com/cosmos/ibc/blob/f990a7f96eb7753c2fabbd49ed50b64d3a807629/README.md)
+- [slashing](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/slashing/spec/README.md)
+- [staking](https://github.com/celestiaorg/cosmos-sdk/blob/v1.14.0-sdk-v0.46.11/x/staking/spec/README.md)
+- [transfer](https://github.com/cosmos/ibc/blob/f990a7f96eb7753c2fabbd49ed50b64d3a807629/spec/app/ics-020-fungible-token-transfer/README.md)
+- [vesting](https://github.com/celestiaorg/cosmos-sdk/tree/v1.14.0-sdk-v0.46.11/x/auth/vesting) (no spec)

specs/template.md

@@ -0,0 +1,37 @@
+# Protocol/Component Name
+
+## Abstract
+
+Provide a concise description of the purpose of the component for which the
+specification is written, along with its contribution to the celestia-app or
+other relevant parts of the system. Make sure to include proper references to
+the relevant sections.
+
+## Protocol/Component Description
+
+Offer a comprehensive explanation of the protocol, covering aspects such as data
+flow, communication mechanisms, and any other details necessary for
+understanding the inner workings of this component.
+
+## Message Structure/Communication Format
+
+If this particular component is expected to communicate over the network,
+outline the structure of the message protocol, including details such as field
+interpretation, message format, and any other relevant information.
+
+## Assumptions and Considerations
+
+If there are any assumptions required for the component's correct operation,
+performance, security, or other expected features, outline them here.
+Additionally, provide any relevant considerations related to security or other
+concerns.
+
+## Implementation
+
+Include a link to the location where the implementation of this protocol can be
+found. Note that specific implementation details should be documented in the
+core-app repository rather than in the specification document.
+
+## References
+
+List any references used or cited in the document.