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
3 stars 1 forks source link

Modified docs structure for the ions database. #36

Closed Pepe-Marquez closed 4 days ago

Pepe-Marquez commented 4 days ago

I added the first skeleton and some modifications to the docs. I also added the first how-to as an example of creating a perovskite composition entry.

Summary by Sourcery

Documentation:

sourcery-ai[bot] commented 4 days ago

Reviewer's Guide by Sourcery

This PR reorganizes and enhances the documentation structure for the perovskite solar cells database, with a focus on adding new sections about the ions database functionality. The changes include restructuring the navigation, adding new how-to guides, and updating the main documentation pages with additional information about ions and perovskite compositions.

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

File-Level Changes

Change Details Files
Restructured main documentation page content and layout
  • Added information about the ions database and perovskite composition schema
  • Reorganized badges and logos placement
  • Updated key features list to include ions database functionality
  • Added acknowledgments section with funding information and logos
  • Removed temporary placeholder sections
docs/index.md
Updated navigation structure and documentation configuration
  • Added new how-to guide pages for ion-related functionality
  • Removed 'Use this Plugin' page
  • Added new navigation features and theme configurations
  • Added glightbox plugin
  • Updated repository and homepage links
mkdocs.yml
Added new documentation pages for ion database functionality
  • Created new pages for ion search, addition, and export functionality
  • Added new tutorial for sharing perovskite compositions
  • Created guide for creating perovskite compositions with embedded iframe tutorial
docs/how_to/search_for_ions.md
docs/how_to/add_a_new_ion.md
docs/how_to/export_a_cation_structure.md
docs/how_to/create_a_perovskite_composition.md
docs/tutorial/sharing_a_perovskite_composition.md

Possibly linked issues


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).