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

[ui] add a docs ui route #124

Closed
signebedi opened this issue Mar 30, 2024 · 3 comments
Closed

[ui] add a docs ui route #124

signebedi opened this issue Mar 30, 2024 · 3 comments

Comments

@signebedi
Copy link
Owner

signebedi commented Mar 30, 2024

This is a little tough. I think we might need to save docs as an app config. That would mean setting a DOCUMENTATION_ENABLED bool and DOCUMENTATION_TEXT Markup string.

We can add a link with the title = "Read site documentation" and using the following bootstrap icon: https://icons.getbootstrap.com/icons/book/. Alternatively, we can write the Docs text with the Source | Privacy text at the bottom right of the footer.

@signebedi
Copy link
Owner Author

signebedi commented Mar 31, 2024

Should we handle this in markdown? I think it will save a lot of trouble. Cf. markdown would require an additional dependency, whereas we have everything we need for HTML right now.... But it's harder to write and lint than markdown, and we would probably need to install an html lint or something like that to write a validator route.

@signebedi
Copy link
Owner Author

[ui] [docs] find a way to handle images in docs
It's worth considering how to upload images for the site documentation.

@signebedi
Copy link
Owner Author

[api] [admin] admin route for docs management
We should create an admin route that will allow users to edit the contents of the docs page.

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

No branches or pull requests

1 participant