Skip to content

Providing a Readme for users of the database #4207

@amca01

Description

@amca01

Problem

I have some databases which I'm making available to the public - but this public is in general ignorant about databases - ( as indeed, mostly, am I). I have created a Readme to explain how to use the databases, which has to be made available as a separate file. So the problem is to include a descriptive, formatted Readme.

Proposed solution

I envisage, with each database, a space for a formatted (html + JavaScript) explanatory text. Whether this is just a link which opens up in a new browser tab, or within Mathesar itself, I haven't decided. But within Mathesar itself would be preferable.

Additional context

I hope I've made myself clear!

Metadata

Metadata

Assignees

No one assigned

    Labels

    affects: uxRelated to user experienceneeds: requirementsThe problem is clear and worth solving, but we're not yet sure of the best solutiontype: enhancementwork: frontendRelated to frontend code in the mathesar_ui directory

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions