update documentation and make it more correct

[vinitkumar]

Summary by Sourcery

Documentation:

• Replace the default MkDocs landing page with a json2xml-focused overview including description, quick-start example, feature list, and links to full docs and source code.

[sourcery-ai]

Reviewer's Guide

Updates the MkDocs landing page to be a proper json2xml project homepage, replacing boilerplate MkDocs text with concise library-specific documentation, example usage, feature list, and external links.

Flow diagram for navigation from json2xml docs homepage

flowchart TD
  A[Docs_homepage_index_md] --> B[Read_brief_library_description]
  B --> C[View_quick_start_Python_example]
  C --> D[Understand_core_usage_pattern]
  B --> E[Scan_feature_list]
  E --> D
  D --> F[Follow_link_to_detailed_documentation]
  D --> G[Follow_link_to_source_code_on_GitHub]
  F --> H[Explore_advanced_usage_and_options]
  G --> I[Review_code_and_contribution_guidelines]

Loading

File-Level Changes

Change	Details	Files
Replace generic MkDocs starter content with project-specific json2xml documentation on the docs homepage.	Update main heading and intro text to describe the json2xml library instead of MkDocs. Add a Python quick-start example showing conversion from a JSON string to XML using json2xml and readfromstring. Introduce a feature list that outlines supported JSON-to-XML conversion capabilities and configuration options. Add sections linking to detailed hosted documentation and the GitHub source repository.	docs/index.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've reviewed your changes and they look great!

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}