Clean up website header

Gorkowski commented 1 month ago

move mk generator to assets folder remove old examples change next to beta features

Fixes #504

Summary by Sourcery

Clean up the website header by updating documentation to reflect beta features, reorganizing the mk_generator script location, and removing obsolete examples.

Enhancements:

Relocate the mk_generator script to the assets folder for better organization.

CI:

Modify the CI workflow to reflect the new location of the mk_generator script.

Documentation:

Update documentation to replace 'Next' with 'Beta Features' and provide a link to Particula-Beta.

Chores:

Remove outdated example notebooks and documentation from the old-examples directory.

github-actions[bot] commented 1 month ago

PR Preview Action v1.4.8 :---: :rocket: Deployed preview to https://uncscode.github.io/particula/pr-preview/pr-508/ on branch gh-pages at 2024-10-16 18:06 UTC

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request focuses on cleaning up the website header by reorganizing content, removing old examples, and updating the documentation structure. The changes primarily involve file deletions, content updates, and minor adjustments to the build process.

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

File-Level Changes

Change	Details	Files
Update documentation structure and content	Rename 'next' folder to 'beta' Update header content for beta features Remove outdated 'Next Outline' section Add material icon to beta features header	`docs/next/index.md` `docs/beta/index.md`
Modify build process	Update path to mk_generator.py script	`.github/workflows/mkdocs.yml`
Remove old examples and documentation	Delete multiple notebook files related to distributions and particle tours Remove old example index files	`docs/old-examples/tour-(old)/part-tour.ipynb` `docs/old-examples/distributions/notebooks/distribution_statistics.ipynb` `docs/old-examples/tour-(old)/Documentation/particle.ipynb` `docs/old-examples/distributions/notebooks/distribution_ambient.ipynb` `docs/old-examples/distributions/notebooks/distribution_evolution.ipynb` `docs/old-examples/distributions/notebooks/distribution_coagulation.ipynb` `docs/old-examples/distributions/notebooks/ionparticle_coagulation.ipynb` `docs/old-examples/tour-(old)/Documentation/vapor.ipynb` `docs/old-examples/distributions/index.md` `docs/old-examples/index.md` `docs/old-examples/tour-(old)/index.md`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#504	Remove mk generator from website header	✅
#504	Remove old examples	✅

Possibly linked issues

#504: PR addresses issue by removing mk generator and old examples, matching issue requirements.
#504: PR moves mk_generator to assets folder, addressing part of the issue's request.

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

uncscode / particula