FAIRmat-NFDI / nomad-perovskite-solar-cells-database

A NOMAD plugin containing the schema for the Perovskite Solar Cell Database.
https://fairmat-nfdi.github.io/nomad-perovskite-solar-cells-database/
Apache License 2.0
4 stars 1 forks source link

Cation documentation #39

Open Pepe-Marquez opened 6 days ago

Pepe-Marquez commented 6 days ago

This is adds additional documentation

Summary by Sourcery

Enhance the documentation for perovskite compositions and ions in NOMAD by adding comprehensive guides and explanations of data schemas, improving user understanding and usability.

Documentation:

sourcery-ai[bot] commented 6 days ago

Reviewer's Guide by Sourcery

This PR significantly enhances the documentation structure and content for perovskite-related functionality in NOMAD. It reorganizes existing content and adds comprehensive documentation about perovskite compositions, ions, and data schemas. The changes include new markdown files with detailed explanations and embedded tutorial videos.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Expanded and restructured perovskite composition documentation
  • Added new sections for creating, downloading, and uploading perovskite compositions
  • Included embedded tutorial videos for various tasks
  • Reorganized content with clear task-based sections
docs/how_to/create_a_perovskite_composition.md
Enhanced ion database documentation
  • Added overview of perovskite ions database functionality
  • Created sections for creating, downloading, and sharing ion data
  • Included embedded tutorials for ion-related tasks
docs/how_to/add_a_new_ion.md
docs/how_to/export_and_explore_ion_data_and_structure.md
Added detailed schema documentation
  • Created comprehensive documentation for perovskite composition schema
  • Added documentation for additives and impurities data schema
  • Added documentation for perovskite ions schema
docs/explanation/perovskite_composition_schema.md
docs/explanation/additives_and_impurities.md
docs/explanation/perovskite_ions_schema.md
Updated main documentation index
  • Reorganized how-to guides section
  • Added new explanation section entries
  • Updated navigation structure
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. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a 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. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) 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](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).