waku-org / waku.org

Waku.org
https://waku.org
3 stars 4 forks source link

setup waku.org and waku.guide websites #15

Open fryorcraken opened 2 years ago

fryorcraken commented 2 years ago

Definition of Done

| Hosting domain       | GitHub Repo               | Framework | Content                           |
| -------------------- | ------------------------- | --------- | --------------------------------- |
| waku.org             | waku-org/waku.org         | acid-info | Waku landing page                 |
| waku.guide           | waku-org/waku.guide       | acid-info | General Waku Doc (md files)       |
| js.waku.guide        | waku-org/js.waku.guide    | hugo      | JS Waku Doc (md files)            |
| go.waku.guide        | waku-org/go.waku.guide    | acid-info | Go Waku Doc (md files)            |
| nim.waku.guide        | waku-org/nim.waku.guide    | acid-info | Nwaku Doc (md files)            |
| js.waku.org          | waku-org/js-waku          | TypeDoc   | JS API Doc (generated html files) |
| examples.waku.org    | waku-org/js-waku-examples | None      | React/HTML/etc websites           |

Tasks

tasks grouped together are sequential


jakubgs commented 2 years ago

I've added the necessary validation TXT records for waku.org and waku.guide: https://github.com/status-im/infra-misc/commit/ab8a10a6

image

This might take an hour or a few though.

jakubgs commented 2 years ago

And they are verified:

image

amirhouieh commented 2 years ago

@fryorcraken we wont use Acid Info framework for waku.guide & *.waku.guide. As discussed we are going to use a fully specialized framework. We have two solid options

  1. https://docusaurus.io/
  2. https://squidfunk.github.io/mkdocs-material/

We prefer number 1 because it is an exact match in terms of tech stack (ReactJs + Typescript) with what we use at branding. It also supports MDX which enables you to have way more control over the content and its structure.

amirhouieh commented 2 years ago

@fryorcraken I would suggest moving all tasks related to documentation websites to their own repos, what do you think?

fryorcraken commented 2 years ago

@fryorcraken I would suggest moving all tasks related to documentation websites to their own repos, what do you think?

Yes, happy to clean up once waku.guide is shipped. It's just that part of the task is creating said repo. I am happy to move the tasks to the repos once they are open.