[Docs] remove docs from README.md #335
Description
The documentation on the website is now more comprehensive, reducing the need to have the same content on the README.
Currently, the README.md is the most accurate reference. I’ll be auditing each section and contributing updates to the website documentation to bring them into parity.
Once everything is synchronized, I’ll open a PR to remove the overlapping content from the README.md.
Audit
| Status | Section | Readme | Tutorial | svelte | svetekit | Notes |
|---|---|---|---|---|---|---|
| Pending | Definig the meta | link | N/A | link | link | update wording to describe export default |
| Pending | Defining stories | link | N/A | link | link | many details are missing in the docs. render is not mentioned. |
| Pending | Typescript | link | N/A | N/A | N/A | |
| Pending | Legacy API | link | N/A | N/A | N/A | this should be in the docs |
| Pending | Version compatibility | link | N/A | N/A | N/A | this should stay in the readme, maybe this tool(TBD) is helpful? |