Update readme

[iv-tunate]

This pull request reorganizes the project documentation by updating the main README.md and splitting its contents into dedicated subsections within the docs/ directory.

[adamreeve]

Thanks for your contribution @iv-tunate.

The documentation under the docs directory isn't intended to be viewed from the GitHub UI, bit is actually the source for our documentation website that uses docfx and gets published to GitHub pages at https://g-research.github.io/ParquetSharp/.

If you're modifying this documentation, you'll need to ensure it integrates with the documentation website build correctly, for example by adding any new pages to the toc.yml files. At the moment, your changes break the documentation website because you've removed the index.md file. And none of the new files you've added are included in the website.

You can build the website by installing docfx:

dotnet tool update -g docfx

Then runing docfx in the docs directory:

docfx docfx.json

You can then view the website with:

docfx serve _site

I haven't closely reviewed your changes so far, but I'm not sure we want the docs split into such small sections. I suggest that rather than making so many big changes all at once, we keep the index.md file as it was and just introduce a new top-level "Contributing" section containing the content about contributing that's currently in the README.

[iv-tunate]

Thanks for your contribution @iv-tunate.

The documentation under the docs directory isn't intended to be viewed from the GitHub UI, bit is actually the source for our documentation website that uses docfx and gets published to GitHub pages at https://g-research.github.io/ParquetSharp/.

If you're modifying this documentation, you'll need to ensure it integrates with the documentation website build correctly, for example by adding any new pages to the toc.yml files. At the moment, your changes break the documentation website because you've removed the index.md file. And none of the new files you've added are included in the website.

You can build the website by installing docfx:

dotnet tool update -g docfx

Then runing docfx in the docs directory:

docfx docfx.json

You can then view the website with:

docfx serve _site

I haven't closely reviewed your changes so far, but I'm not sure we want the docs split into such small sections. I suggest that rather than making so many big changes all at once, we keep the index.md file as it was and just introduce a new top-level "Contributing" section containing the content about contributing that's currently in the README.

Thanks for your contribution @iv-tunate.

The documentation under the docs directory isn't intended to be viewed from the GitHub UI, bit is actually the source for our documentation website that uses docfx and gets published to GitHub pages at https://g-research.github.io/ParquetSharp/.

If you're modifying this documentation, you'll need to ensure it integrates with the documentation website build correctly, for example by adding any new pages to the toc.yml files. At the moment, your changes break the documentation website because you've removed the index.md file. And none of the new files you've added are included in the website.

You can build the website by installing docfx:

dotnet tool update -g docfx

Then runing docfx in the docs directory:

docfx docfx.json

You can then view the website with:

docfx serve _site

I haven't closely reviewed your changes so far, but I'm not sure we want the docs split into such small sections. I suggest that rather than making so many big changes all at once, we keep the index.md file as it was and just introduce a new top-level "Contributing" section containing the content about contributing that's currently in the README.

Got it...
Thank you