Skip to content

Conversation

@Samuel-Villegas
Copy link
Contributor

Description

Updated the project structure based on a more up-to-date understanding of the project needs:

  • Renamed some blocks for better clarity and consistent naming
  • Reorganized the project structure

Documentation website's page contents need revision before making an official (non-draft) pull request.

Type of change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
    • Changes to naming or project structure may break existing functionality or cause confusion if previous naming conventions are still used
  • This change requires a documentation update
    • Documentation needs to be updated to meet the revised naming conventions

How Has This Been Tested?

  • Manual inspection of the website to make sure the revised structure makes sense and is can be understood
  • Manual inspection of the website to make sure the contents of the pages make sense and can be understood

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
    • Page contents still need to be reviewed
  • I have commented my code, particularly in hard-to-understand areas
    • Documentation changes only
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
    • Some of the repositories and project-specific documentation may still be using previous structure or naming conventions

@Samuel-Villegas Samuel-Villegas added the documentation Improvements or additions to documentation label Apr 9, 2021
@Samuel-Villegas Samuel-Villegas self-assigned this Apr 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant