Skip to content
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

[ENH] Guides: Streamline Development Documentation for Oqtane #90

Open
thabaum opened this issue Nov 7, 2024 · 0 comments
Open

[ENH] Guides: Streamline Development Documentation for Oqtane #90

thabaum opened this issue Nov 7, 2024 · 0 comments

Comments

@thabaum
Copy link
Contributor

thabaum commented Nov 7, 2024

The current documentation structure for Oqtane is fragmented across multiple sections, making it difficult for developers to find the necessary resources for building extensions, modules, themes, or contributing to the core framework. We propose consolidating development-related content into a single "Development" section with clear subsections for Core Framework Development, Modules, Themes, and Extensions. Additionally, the troubleshooting section should be reorganized to provide more centralized troubleshooting resources for development issues across all areas.

Key Improvements:

  • Unified Development Section: Merge content related to modules, themes, and extensions under a single "Development" section.
  • Core Development: Provide a dedicated section for modifying and contributing to Oqtane's core framework.
  • Troubleshooting: Centralize troubleshooting content related to development in one place, with links to specific sections like modules, themes, and extensions.
  • Contributing to Oqtane: Add a guide for contributing to the Oqtane framework itself, focusing on code contribution and pull requests.

By improving the structure and flow of the development section, we aim to make it easier for developers to find relevant information, contribute to the project, and troubleshoot issues.

An general example for a simplified idea of how we may structure this in our TOC guides section:

Guides:
  - **Guides Home**
  - **Concepts**:
      - Introduction to Oqtane
      - DLL Handling
      - 404 Page Behavior 
      - How Oqtane Works: Modules, Themes, Extensions
      - **Working with Modules**: 
          - Overview of Modules
          - How Modules Integrate with Oqtane
      - **Working with Themes**: 
          - Overview of Themes
          - How Themes Work in Oqtane
       - **Working with the Marketplace**: 
          - Overview of the Marketplace
          - Key Features of the Oqtane Marketplace
  - **Development**:
      - Overview of Oqtane Development
      - **Core Framework Development**
          - Introduction to Core Development
          - Modifying Oqtane’s Core
          - Contributing to Oqtane Framework
      - **Modules**:
          - Developing Modules
          - Troubleshooting Modules
      - **Themes**:
          - Developing Themes
          - Troubleshooting Themes
      - **Extensions**:
          - Developing Extensions
          - Troubleshooting Extensions
  - **Troubleshooting**:
      - General Troubleshooting
      - Troubleshooting Development (Modules, Themes, Extensions)
      - Troubleshooting Installation
      - Troubleshooting Marketplace
      - Troubleshooting Login Issues
      - Troubleshooting User Registration Email Verification 
  - **Installation**
  - **Roadmap & History**

Lots of pages missing here in this general outline but gives an idea how we can possibly structure this. I look forward to talking more about it at the next meeting.

We need to review the content we have and what pages would go where exactly, but this should help get an idea of what we may be able to do to enhance developing on Oqtane and the Oqtane Framework itself.

The core reason anyone gets Oqtane is to develop with it. We really need to get this area primed up during the next release 6.0.0 is my hope for the next direction we go with Oqtane documentation now that the "Core" use features have been enhanced.

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

No branches or pull requests

1 participant