docs(parser): share oxc_parser module docs with oxc::parser

[DonIsaac]

What This PR Does

Moves oxc_parser module documentation to a README.md file so that the
oxc crate can benefit from it as well.

The downside of this PR is that it breaks example inclusion with
#![doc include_str(..)], since macros in loaded files are not run. I'm
not 100% sure that the tradeoffs are worth it, but this is worth
discussing.

[DonIsaac]

• docs(parser): share oxc_parser module docs with oxc::parser #5832 👈
• docs(parser): add module and struct level documentation #5831
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @DonIsaac and the rest of your teammates on Graphite

[graphite-app]

Your org has enabled the Graphite merge queue for merging into main

Add the label “0-merge” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “hotfix” to add to the merge queue as a hot fix.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

[codspeed-hq]

CodSpeed Performance Report

Merging #5832 will not alter performance

_{Comparing 09-17-docs_parser_share_oxc_parser_module_docs_with_oxc_parser_ (174c0dc) with main (3148d4b)}

Summary

✅ 29 untouched benchmarks

[overlookmotel]

since macros in loaded files are not run

Did you mean examples in loaded files are not run?

[DonIsaac]

since macros in loaded files are not run

Did you mean examples in loaded files are not run?

I did not.

Given this README:

Here's a description for some stuff 

## Example
'''rust
#![doc = include_str!("../examples/foo.rs")]
'''

note: using single quotes instead of backticks above as to not break formatting of this comment

When this gets loaded in as documentation in lib.rs

#![doc = include_str!("../README.md")]

then the macro invocation in README.md (include_str!("../examples/foo.rs")) wiil not be invoked, and will instead be displayed as-is.

[overlookmotel]

Ah. Now I understand. Thanks for explaining.

[Boshen]

This seems confusing, maybe just a docs.rs link to the actual crate should suffice?