Skip to content

Add mechanism for easy display or download of documentation #4

@jakemcivor

Description

@jakemcivor

PDFs are a convenient format for documentation, but longer documents are truncated when viewed directly from within GitHub.

For example, the only the first 5 pages of the LipSync User Guide (https://github.com/makersmakingchange/LipSync/blob/main/Documentation/LipSync_User_Guide.pdf) are displayed. There is a button to display more pages at the bottom of the interface, but this can be come tedious with larger documents.

It is possible to reformat a link to point to the raw version of content, which will typically prompt the user to download the file within their web browser. e.g., https://raw.githubusercontent.com/makersmakingchange/LipSync/main/Documentation/LipSync_User_Guide.pdf Accessing the raw link is also possible by clicking the 'Download raw file' button at the link above, but this may not be obvious for users that are not familiar with the GitHub interface.

It would be nice to have a way to provide these options in a way that is more intuitive for all users, regardless of their experience with the GitHub interface. Ideally, this would consist of any documentation being displayed directly in the browser like a typical PDF, as well as an intuitive option to download the file if they wish.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions