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

Docs should be embedded in the app, not linked via Github #568

Open
brassy-endomorph opened this issue Sep 10, 2024 · 0 comments
Open

Docs should be embedded in the app, not linked via Github #568

brassy-endomorph opened this issue Sep 10, 2024 · 0 comments

Comments

@brassy-endomorph
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

On the submission page, the docs about how to upload a PGP key are linked in some help text. The hyperlink goes to a rendered markdown doc hosted on Github. This leaks information.

Describe the solution you'd like

Any docs or help pages we think a user (submitter, recipient) might want to read should be embedded in the app as pre-rendered HTML snippets (no need for a markdown renderer shipped, just do it at build time using dev deps).

This has the advantage of us being able to update docs on main without risk of breaking hyperlinks in apps. It means every app will have correctly version docs always displayed. There will not need to be synchronization between app and doc updates.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: BL-P6 - Code & Doc Enhancements
Development

No branches or pull requests

1 participant