✨📚 New documentation website and project name re-meaning

[pleonex]

Description

The goal is to rebump this project with a name that doesn't limit it to ROM Hacking, as it's a generic format conversion library. Additionally, this library provides a lot of nice features but it doesn't have any documentation so it's hard to know about them or how to use it.

This PR provides new documentation website with modern look, explaining the features of the library with code snippets.

TODO:

• [x] Tech selection
• [x] Setup website
• [x] Remove other PoC
• [x] Adapt CI
• [x] Improve README
• [x] Create new ToC
• [x] Write introduction
• [x] Write getting started guide
• [x] Write about formats and converters
• [x] Write about DataStream
• [x] Write about file system classes
• [x] Integrate changelog

Tech selection - Site generator

Hugo Toha

• Web
• Cons:
  • project is under a re-write.
  • its focus is not documentation.

Docusaurus

• Web
• Pro:
  • Modern look
  • Used by many software projects for documentation -Cons:
  • It forces to use MDX instead of pure markdown (even on .md files) causing several issues.
  • It will fail if you have HTML in markdown with open bracks (e.g. <br> generated by doc generators) or with some generics types if they are not in code blocks.
  • It runs with npm/react. It creates their typical chaos of environment of node_modules, vulnerable dependencies, version mismatches.
  • Fails with self linking (generated by most C# doc generators)...
  • No theming available apart from main one, it allows some CSS overrides.
  • Made by Meta 😕

PoC:

Statiq (before Wyam)

• Web
• Pro:
  • It can generate API docs for .NET projects as well as static sites.
  • It allows customization (e.g. markdown shortcuts) with C# code.
  • It has pure markdown OR Razor templates (cshtml).
• Cons:
  • It doesn't look as modern as Docusuarus / DocFX
  • Still on beta after re-writing Wyam, missing features like cards or including files. It's a one-person project.

PoC:

DocFX

• Web
• Pro:
  • Kind of an standard in .NET projects since a long time ago
  • Modern look and features after moving as a .NET Foundation project
  • Look of C# API match .NET library docs
  • Supports many features in markdown like cards and file inclusion
  • Several themes available
• Cons:
  • None so far.

PoC:

Tech selection - C# docs as markdown

Note: not needed anymore as I will be using DocFX. Same if we were going to choose Statiq.

xmldoc2md

• Web
• Pro:
  • Good output
  • Good CLI
  • Creates an index
  • Except for <br> works with Docusuarus.
• Cons:
  • Can't generate docs for multiple DLLs (they don't link between)
  • Flat hierarchy, too many docs under same folder.

ModularDoc

• Web
• Pro:
  • It works with multiple DLLs
  • It can create a structure of folders by namespace
• Cons:
  • It documents private and internal fields
  • The title of the docs contains public/internal
  • It's work in progress.
  • Can't get to work the CLI because the GUI that generates config crashes
  • Hard to make it work with Docusaurus: breaks <br> and some generic types without code blocks.

Vsxmd

• Web
• Cons:
  • Generates the full API docs in a single markdown file.

Example

Soon available at https://scenegate.github.io/Yarhl 😉

This closes #175