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

Reorganize files into a flat structure #4

Closed
wants to merge 7 commits into from

Conversation

shainaraskas
Copy link
Collaborator

@shainaraskas shainaraskas commented May 22, 2024

This PR reorganizes our files into a flat structure, and updates xrefs so all images and partials load as intended.

The flat structure is intended to:

  • allow us to play with information architecture in future while minimizing file moves in the backend
  • allow us to share certain resources that require relative paths easily
  • adhere to the versioning structure we expect we will use (backporting TODO)

If we decide that this structure isn’t granular enough to navigate for our contributors, we can add additional subfolders later.

serverless      # the deployment type
├── pages       # mdx pages
├── images      # you get it
├── nav         # nav files for serverless
└── partials    # mdx included in other pages    

nb: the partials we currently have are only used in a single place. in my opinion, these could be integrated into the parent page.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

duplicate

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

duplicate

@shainaraskas shainaraskas changed the title flatten Reorganize files into a flat structure May 22, 2024
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure why this is detecting as a new file, but it's not letting me fix it

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