Development - #11
Merged
Merged
Conversation
- Complete documentation restructure with professional Julia package style - Added dedicated pages: Installation, Usage, Examples, API Reference - Configured GitHub Pages with automatic deployment workflow - Updated all README links and badges to point to correct fork repository - Translated all documentation to English - Added GitHub Actions workflow for docs deployment - Documentation available at: https://sebastianbanda1.github.io/OptiPlant/ Features: - CSV.jl-style landing page with clear navigation - Comprehensive installation guide with troubleshooting - Detailed usage guide from basic to advanced scenarios - Practical examples for all major use cases - Complete API reference documentation - Interactive dashboard integration - Automatic stable/latest versioning
- Enable automatic documentation deployment - GitHub Pages now configured with GitHub Actions source
- Add workflow_dispatch to allow manual execution - Keep documentation deployment on Development branch
- Complete documentation restructure following CSV.jl style - Add comprehensive Installation, Usage, Examples, and API reference pages - Fix all repository URLs to point to main njbca/OptiPlant repository - Update GitHub Pages configuration for njbca.github.io/OptiPlant - Add technical documentation guide for collaborators - Translate all content to English - Remove nested OptiPlant directory causing conflicts
- Updated all documentation to match official PowerPoint user guide exactly - Replaced index.md with correct OptiPlant description and capabilities - Rewrote installation.md with precise Julia/VS Code/packages setup steps - Updated usage.md with accurate file structure and workflow - Replaced Examples.md with comprehensive troubleshooting section - Rewrote api.md with technical specifications from user guide - Updated README.md with official project description and citations - Removed all outdated/incorrect information - Added proper scientific references and DOI links - Structured content following user guide organization
- Clean documentation text without emoji decorations - Maintain professional appearance - Remove visual clutter for better accessibility
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.