Use git submodules to import dependent repositories about documentation-hub HOT 5 CLOSED

@mradkov @nikita-fuchs FYI I am working on this now. I will add following repos with mkdocs initially:

• https://github.com/aeternity/protocol (mkdocs currently missing)
  • open PR: aeternity/protocol#494
• https://github.com/aeternity/aeternity (mkdocs already configured correctly)
  • the current docs are hosted at https://docs.aeternity.io/en/stable/ using the ReadTheDocs Theme
• https://github.com/aeternity/aesophia (mkdocs currently missing)
  • there is an open PR where I can at least check and copy the mkdocs.yml (aeternity/aesophia#282) - currently not sure if we need additional changes to the docs here
  • new PR now here: aeternity/aesophia#333
• https://github.com/aeternity/aepp-sdk-js (mkdocs available but needs to be fixed / improved)
  • there is a branch where this is being tackled by @nikita-fuchs (https://github.com/aeternity/aepp-sdk-js/tree/readTheDocs-optimized) but I am not sure if I can and will make use of it
  • done: aeternity/aepp-sdk-js#1229

When this is finished the maintainers of each repo are responsible to keep it up to date. The only thing we would need to figure out then is how to automate updates to the documentation hub based on changes in the repos of the submodules. But let's get this done first.

Ideally we include docs for other tools like https://github.com/aeternity/aepp-aeproject-js shortly after this is done.

I will probably make use of the Material theme here. We will see.

Probably I will make some additional changes wherever needed.

from documentation-hub.

there are another 2 things to be aware of right now:

• site_name with spaces isn't allowed using the monorepo plugin (backstage/mkdocs-monorepo-plugin#4)
  • the comments in the issue propose some workarounds for that
  • the following script can help with this: https://git.sitnikov.ga/gas/mkdocs_scripts/src/branch/master/site_name_updater.sh
• the command mkdocs serve seems to be broken right now (backstage/mkdocs-monorepo-plugin#49)

from documentation-hub.

I was looking into this topic recently and found this mkdocs plugin which allows us to do that quite easily:

• https://github.com/backstage/mkdocs-monorepo-plugin

I was testing it in a separate repository:

• https://github.com/marc0olo/mkdocs-submodule-playground

the only bug I identified is that the edit url of submodule pages cannot be provided correctly. the issue about that is here:

• backstage/mkdocs-monorepo-plugin#45

from documentation-hub.

new PR for aesophia is open now:

• aeternity/aesophia#333

from documentation-hub.

new PR for the protocol is open now:

• aeternity/protocol#494

from documentation-hub.