Skip to content

[FEATURE] Comprehensive Internal Documentation for md-latex #21

@iamvirul

Description

@iamvirul

Feature Description

We need to add a comprehensive internal documentation and help section directly within the web interface to cover all features of md latex.

Motivation

As the application grows with advanced features (LaTeX rendering, bibliography management, export and import, encrypted URL sharing, auto snapshots, cherry picking diffs), users need a central place to learn how EVERYTHING works without leaving the app.

Proposed Solution

Add a Help or Docs section accessible from the sidebar or toolbar that details:

  • General Usage: How the Markdown and LaTeX transpilation works.
  • File Management: Using the virtual file tree and creating folders.
  • Bibliography: How to upload and cite from .bib files.
  • Workspace Management: Using Named Workspaces, the Workspace Switcher, and auto snapshots.
  • Security: How password protection works (AES 256 encryption) and its security implications.
  • Sharing: How URL sharing works and size limits.
  • Import: How to drag and drop import and cherry pick specific files.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request
    No fields configured for Feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions