feat(docs): init docs

[Ushie]

No description provided.

[revanced-bot]

Deployed at https://ea6fcf2e.revanced.pages.dev.

[revanced-bot]

Deployed at https://30ee5bd9.revanced.pages.dev.

[revanced-bot]

Deployed at https://fdf03114.revanced.pages.dev.

[revanced-bot]

Deployed at https://aa48f574.revanced.pages.dev.

[revanced-bot]

Deployed at https://97ff6f30.revanced.pages.dev.

[revanced-bot]

Deployed at https://06473984.revanced.pages.dev.

[kazimmt]

Is it possible to add Image reference also for better understanding?

Refer to: This

[revanced-bot]

Deployed at https://head.revanced.pages.dev.

[Ushie]

😮

[Ushie]

bruh the deployment link is for donation branch

[xafn]

💀

[kazimmt]

Review from current preview
If i click on the right side i.e. installation step
Top Menu goes away

edit: clicking any header makes the top menu disappear.

[Ushie]

I know what causes that, I'll fix that later tonight

[xafn]

bruh the deployment link is for donation branch

hard refresh page ctrl shift r, it was just cache

[revanced-bot]

Deployed at https://d152fd7d.revanced.pages.dev.

[Ushie]

FAT

[oSumAtrIX]

Before this reaches production or even dev, a solution should be figured out regarding the issue of copying all the MD files. I suggest the following:

1. Every repo with docs integrates Docusaurus. This feature change will transform all the MD files to "Docusaurus formatted" MD files.
2. In junction with feat: add site configuration #137, the website offers a configuration that allows the following:
   • Specify a repository to get documentation from (in our case, the docs repo that contains submodules of all other reports)
   • Provide a mapping between the docs of the separate repos and categories that are exclusive to the website

This will allow:

1. All the repositories to host docs standalone and independent of the website
2. Deduplicate the docs
3. Allow automatisation of updating the docs (at build time over triggering a CI specifically for docs)
4. Remain agnostic apart from the configuration file (as specified in feat: add site configuration #137), which would be an env-specific configuration anyways

To proceed with this proposal, all the repos must first migrate to Docusaurus. For that, an issue may be opened, and a template repository could be provided that all the reports can add as a submodule to avoid code duplication and easily updating the docs by updating the submodule.

[xafn]

1. Every repo with docs integrates Docusaurus. This feature change will transform all the MD files to "Docusaurus formatted" MD files.

What changes would be needed to the .md files? Or are you referring to how Docusaurus needs a _category.json file , in which case can also be generated through CI.

{
    "label": "ReVanced Development",
    "position": 1,
    "link": {
        "type": "generated-index"
    }
}

[oSumAtrIX]

What changes would be needed to the .md files?

The MD files in this PR have been changed to a specific format that is suitable for Docusaurus:

1. The "Whats next" section is removed
2. A Docusaurus header is added

are you referring to how Docusaurus needs a _category.json file , in which case can also be generated through CI.

The category files should not be generated by CI. The reason for this is, that both the documentation as well as the categories (part of the documentation) are environment-specific configurations. As #137 specified, this project should offer a configuration that allows ending agnostics at an environment-specific level. This means, the project itself remains agnostic, including CI, but the "ReVanced" configuration, that would be deployed, would be configured so that the site consumes our documentation and uses our set of category JSON files. Another deployment environment then can use its own site configuration as a product of the site being agnostic.