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

Restructuring the Documentation Navigation #85

Closed
al-fisher opened this issue Nov 23, 2023 · 1 comment · Fixed by #92
Closed

Restructuring the Documentation Navigation #85

al-fisher opened this issue Nov 23, 2023 · 1 comment · Fixed by #92
Assignees

Comments

@al-fisher
Copy link
Member

As per conversions on PR here: #83 (comment)

New structure of the Documentation to be implemented as below. Specifically to support better separation of documentation for our different target users: contributors vs visual programmers vs coders

As well as being more readable - idea is to organise our material better to help grow further contributions and co-authorship -specifically of this documentation - from the wider team and beyond through creation of more Guides and Tutorials, as well as code documentation across the oM and Engines

WIP proposed Documentation menu

  • Welcome

  • Introduction

    • What is the BHoM for?
    • Installing the BHoM
    • Using the BHoM
    • The BHoM Toolkit
    • The BHoM Code Organisation
    • Technical philosophy
  • BHoM oM

    • **What is the oM? Commmon Language
    • The Object Model (oM): define new objects
    • Geometry_oM
    • Conventions
    • ...
  • BHoM Engine

    • What is the Engine
    • ...
  • BHoM Adapter

    • ...
  • BHoM UI

    • ...
  • Contributing

    • Raising issue
    • Editing docs etc.
    • ...
    • ** Development Procedure
  • Guides and Tutorials

    • **Computational Thinking with BHoM
      • **Getting started for designers
    • Visual Programming with BHoM
      • Getting started for scripters
      • **Custom Objects
      • **Accessing Datasets
      • **Revit_Toolkit
        • **Revit Adpater in GH etc.
        • **Push/Pull etc. etc.
      • **Structural Analysis Models
    • Coding with BHoM
      • Getting started for developers
      • **Calling Datasets from code
      • **Revit_Toolkit
        • **Code Structure/Parameters etc.
@al-fisher
Copy link
Member Author

As just discussed and coordinated with @alelom - I will continue to close out this restructuring.
I will raise a PR shortly for visibility.

Then once complete we can also address some of the global conventions such as #86 and other issues recently raised.

@alelom @pawelbaran @travispotterBH FYI

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 a pull request may close this issue.

1 participant