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

Extract Dictionary Content to a Standalone Repository #1

Open
babblebey opened this issue Sep 21, 2024 · 0 comments
Open

Extract Dictionary Content to a Standalone Repository #1

babblebey opened this issue Sep 21, 2024 · 0 comments

Comments

@babblebey
Copy link
Member

  • Implementation PR:

Summary

We plan to extract the dictionary content (currently stored as .mdx files) from the main jargonsdev/jargons.dev repository and move it to a dedicated repository. This separation will allow us to use Astro’s new content layer feature to load dictionary content dynamically from a remote source, improving the maintainability and scalability of the project.

Motivation

Currently, both the jargons.dev app source code and the dictionary content reside in the same repository. This setup limits the ability to manage and scale these components separately. By moving the dictionary content to its own repository, we can:

  • Separate the content from the app code, enabling more focused contributions.
  • Make it easier for contributors to update content without touching the app code.
  • Leverage the Astro content layer to dynamically load content from a remote source, allowing for more flexibility.

Goal

  1. Create a new repository for dictionary content, for example, jargonsdev/dictionary.
  2. Extract all .mdx files from the current jargonsdev/jargons.dev repository in the content/dictionary directory and move them to the new repository.
  3. Integrate Astro’s content layer to fetch and load the dictionary content from the new remote repository into the app.
  4. Update contribution guidelines to reflect the new structure, making it clear how to contribute to both the app and the dictionary content.
  5. Test and validate the integration to ensure the dictionary content is properly loaded and the app functions as expected.

By achieving these goals, we will streamline the management of content and code, paving the way for more efficient collaboration and future scalability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Planned
Development

No branches or pull requests

1 participant