Readme/update contributing guidelines

[divine7022]

This PR updates the Contributing section in the README to include guidelines for adding or editing documentation pages. It specifies the use of explicit heading IDs to prevent broken links when headings change and provides details on supported file formats (.md, .mdx). A reference to the official Docusaurus documentation is also included for further guidance.

[divine7022]

Though I'm still not clear why either these are required / or why we would get warnings.

Docs said that these links will be automatically generated if not provided. https://docusaurus.io/docs/next/markdown-features/toc#heading-ids

I also want to make sure that we are solving the right problem. If this is required for all (or any) new pages, could you please update the contributing section of the README with info about using these links? - mostly what pages and header levels require them and how they should be formatted. It can be brief with a link to the docusaurus documentation (above). 🙏

@dlebauer hello sir,
I've updated the Contributing section in the README(as we discussed in here) to include information about using explicit heading IDs in documentation pages. The update explains why they are needed, how to format them, and links to the relevant Docusaurus documentation for further reference.

Let me know if any further adjustments are needed!
Thank you!

[dlebauer]

Hi @divine7022

Apologies - I didn't realize that I could commit directly to your branch instead of submitting a pull request.

But I made some revisions (8ee9d54) and would appreciate if you can review this page again.

Key changes

• removed 'documentation' section, since PEcAn documentation is in the book_source folder of the pecanproject/pecan repository. Moved it above and changed it to a more general section 'content file formats' on md formatting.
• removed screenshots - they didn't belong where they were, and it wasn't clear if they were necessary, and they were large enough to break the flow of reading a readme.

[divine7022]

@dlebauer
No problem at all! Thanks for making the revisions. I have reviewed the changes, and changing the title to 'Content File Formats' makes sense. Moving this part above also improves the structure