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

[Request]: Database Integration #44

Open
markwillow opened this issue Aug 5, 2024 · 2 comments
Open

[Request]: Database Integration #44

markwillow opened this issue Aug 5, 2024 · 2 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@markwillow
Copy link

What feature would you like to add?

I am currently working as a developer for a retail company. We are looking to enhance our knowledge base by transitioning from Markdown (MD) files to a database format. This migration will allow for more efficient data management and retrieval. I will be spearheading this project and providing feedback throughout the process to ensure a smooth transition and optimal implementation.

Notes

No response

@lukas-frey
Copy link
Contributor

lukas-frey commented Aug 5, 2024

Hi, a PR for that is welcome.

Each documentation file is already implemented like a sushi eloquent model, so it shouldn't be too hard to implement an additional real database model.

However, even then the documentation should be stored as markdown, to allow interoperability and to have to only maintain a single parser.

In my mind, I imagined the package would support three distinct ways of writing / storing the knowledge base documentations:

  1. Markdown files in /docs/ - current approach, already working
  2. PHP classes stored in App/Docs/ - not working currently. In the background, these would be converted into sushi models as well
  3. Database Eloquent models - not implemented yet. This would store the documentation in the database, allowing the documentation to be edited within the filament panels. Preferrably, this would also be implemented with a default editor. Kind of like a wikipedia page.

@markwillow
Copy link
Author

That's right. However, I still need to review the MD documentation. I've been trying to use Blade View for this, but I noticed that it is not compatible, or maybe I'm doing it incorrectly.

In our case, we really need to have this converted to a database because that would be a lot of work for us developers to update stuff from time to time. Especially in emergency cases.

@lukas-frey lukas-frey added enhancement New feature or request help wanted Extra attention is needed labels Aug 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants