Skip to content

Enhance Linear Algebra Documentation Structure and Navigation #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 23, 2025

Conversation

AronT-TLV
Copy link
Member

This PR enhances the Linear Algebra documentation with improved structure, navigation, and development workflow improvements.

Changes Made:

Documentation Structure:

  • Restructured main documentation page (index.md) to focus on core Linear Algebra functions
  • Created dedicated navigation page (sites.md) for FourM study site ecosystem
  • Added Linear Algebra logo integration in documentation
  • Updated make.jl to include sites.md in pages configuration

Development Workflow:

  • Added LiveServer dependency to Project.toml for local documentation testing
  • Enables julia -e 'using LiveServer; serve(dir="docs/build", port=8001)' workflow
  • Improves developer experience for documentation preview

Navigation Improvements:

  • Clear separation between function documentation and site navigation
  • Proper identification of "current site" in cross-site navigation
  • Consistent with Math Foundations documentation structure

Testing Completed:

  • Local LiveServer testing verified all documentation renders correctly
  • Navigation links tested and working
  • Logo integration verified
  • Cross-site navigation consistency confirmed

Technical Details:

  • Follows established patterns from Math Foundations repository
  • Maintains compatibility with existing Documenter.jl deployment
  • Supports conditional CI deployment optimization
  • Enhances developer workflow without affecting production deployment

This PR will also test the conditional CI deployment logic since it contains documentation-related file changes.

- Add logo.png to assets directory for automatic Documenter.jl integration
- Remove navigation section from index.md and create dedicated sites.md page
- Update sites.md to reflect Linear Algebra as current site
- Add sites.md to pages list in make.jl for proper sidebar inclusion
- Improve documentation organization following Math_Foundations pattern
- Add LiveServer package to project dependencies
- Enables local documentation preview with julia --project=. -e 'using LiveServer; serve(dir="docs/build", port=8001)'
- Facilitates development workflow for documentation changes
@AronT-TLV AronT-TLV merged commit a3c34b8 into main Jul 23, 2025
2 checks passed
@AronT-TLV AronT-TLV deleted the feature/enhance-documentation branch July 23, 2025 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant