chathura-de-silva/barnsley-fractal

Barnsley fractal, implemented in Python as a simple but highly configurable 2-dimensional visualization with complete documentation.

🐾 GitHub Statistics

🐾 Top languages

Connect with me :

barnsley-fractal's Issues

Proposed Documentation Site Enhancement for Barnsley-Fractal

Proposed Documentation Site Enhancement for Barnsley-Fractal

Description

I'd like to propose enhancing the Barnsley-Fractal repository with an improved documentation site using Docsify. Docsify is a lightweight and flexible documentation generator that makes it easy to create beautiful, organized, and user-friendly documentation websites.

Motivation

Good documentation is essential for both users and contributors to the Barnsley-Fractal project. Docsify can help us create a more engaging and user-friendly documentation site, which will ultimately improve the experience for everyone.

Suggested Changes

I suggest the following changes as part of this enhancement:

1. Setting up Docsify in a designated folder within the Barnsley-Fractal repository.
2. Creating and structuring documentation content to match Barnsley-Fractal's needs.
3. Configuring Docsify's settings, themes, and plugins to provide a seamless experience.

Implementation Steps

To achieve this, here are the proposed implementation steps:

1. Create a new branch for the documentation site: git checkout -b docsify-enhancement
2. Set up Docsify within the Barnsley-Fractal repository.
3. Add content to the documentation site.
4. Configure Docsify according to Barnsley-Fractal's needs.
5. Test the documentation site to ensure it works as expected.
6. Make a pull request with the changes and seek feedback from the community.

Hosting

It would be ideal if the documentation site could be hosted through GitHub Pages for easy access.

Additional Information

If there are specific details, suggestions, or ideas for the documentation site, please provide them here. Feel free to discuss and share your thoughts on this enhancement.

Related Issues

If there are any related issues, please link them here for context.

Assignees

Assign this issue to any relevant contributors if you have someone in mind.

Labels

Consider labeling this issue with tags like "documentation," "enhancement," and "Docsify" for easier tracking and organization.

Thank you for considering this proposal, and let's work together to enhance Barnsley-Fractal's documentation!

Implementation of the Barnsley fractal in any other language of choice.

• Currently implementations are only available in Python. I am working on a Julia one which focuses more on mathematical aspect with accuracy and precision in contrast to the Python implementation which prioritizes better visualization with Realtime plotting.

• You can implement the Barnsley fractal using any other language of your choice focusing on Realtime visualization aspect. (Again, Julia implementation is still under development. But still you could contribute with a math and precision focused one with enough flexibility to tweak if you really want to)

• Encouraged to implement everything as similar as possible to the existing python implementation. Any improvements are welcome and differences due to limitations of the available third-party dependencies of the chosen language is completely fine. (Lacking ability to tweak just one or two non-crucial parameters are also totally fine)

• Open a pull request mentioning the language you've used in your implementation after completing the implementation.

• No need to rewrite documentation again but appreciated if possible. Otherwise open an issue for that mentioning what are the differences and additions when compared to the base implementation you followed, either Python or Julia*. Add the label documentation to the issue.

Implementation in Julia focusing more accurate and precise mathematical output instead of a Realtime visualization.

• This repository contains only a simple single script python project. Converting this implementation into Julia language is the requirement.

Note

You don't have to have prior knowledge about the "Barnsley Fractal" for this.

• You can go through the documentation provided in the README and get the idea very easily about the current python script.

• Additional functionalities are always welcome and the minor alterations due to limited resources depending on the language is complete fine.

• Focus more on precise plot and tweaks to observe the mathematical perspective more, rather than a limited resolution Realtime plot.

PS : No need to recreate documentation!

What you have to refer : barnsley_fractal.py

Documentation for the current Python implementation : README.md