diff --git a/README.md b/README.md index c8ff73a08d..3a5738b2a9 100644 --- a/README.md +++ b/README.md @@ -14,16 +14,8 @@ Follow the steps below to get a working local installation of this documentation 2. Once it's done, run `npm start`. This command starts a local development server and opens up a browser window. Most changes are reflected live without needing to restart the server. 3. Depending where you host it, you can build the website using `npm build` if you intend to upload it yourself, or build it _and_ deploy it to Github pages using `GIT_USER= USE_SSH=true npm deploy`. The later is a convenient way to build the website and push to the `gh-pages` branch. -## Immediate Plans - -We are currently migrating all data from the old XML documentation site to this website (and we need help for this! Read on to see how to help). - -Once this migration step is finished and this website has safely acquired all old data, we can begin to expand and the website will be ready for users to document additional features. In the meantime, if you find an undocumented feature, please create an Issue for it so it does not go unnoticed. - ## How to Contribute -**`NOTE`**: Help us migrate old data! Check the `Help Migrate Past Files` guide on our website for details. - Before opening a Pull Request, please: - Verify that there is no ongoing discussion concerning the implementation you wish to contribute. You can search for such a discussion in this repo's issues page. diff --git a/docs/guides/contribute/migrate.mdx b/docs/guides/contribute/migrate.mdx deleted file mode 100644 index 7bab739c46..0000000000 --- a/docs/guides/contribute/migrate.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: migrate -title: Help Us Migrate Past Files! ---- - -We need help migrating the old documentation files to this website. These were written in HAML, and need to be converted to Markdown and HTML/JSX (the technologies that the new documentation website uses). In order to do so, please continue reading this guide. - -First, select a documentation file from `reference`, `guides` or `modules`, all located within the `src` folder in the old [XML Documentation repository](https://github.com/OvercastNetwork/docs.oc.tc), and convert it to HTML/ERB using [this tool](https://haml2erb.org). - -Once you've got an HTML file, remove all unnecessary HTML. You will notice what's necessary or what's not if you take a look at existing migrated documents [here](https://github.com/Electroid/PGM/blob/docs/docs), but generally you should maintain only maintain HTML tables, with a few exceptions: - -- Replace `<%= html_escape([XML Tags] %>` with `` {`[XML TAGS]`} ``. Since Docusaurus 2 supports MDX, this is the only way to escape XML from rendering inside an HTML table. -- Replace `` and possible child `` elements with `