obsidian-plugin/anthonyfitzpatrick_manuscript-compiler
1
0
Fork 0
mirror of https://github.com/anthonyfitzpatrick/manuscript-compiler.git synced 2026-07-22 08:31:19 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
anthonyfitzpatrick_manuscri.../SUPPORT.md
Anthony Fitzpatrick 1da688ee91 Bundle logo and attest release artifacts
2026-07-17 18:46:01 +02:00

3.6 KiB
Raw Permalink Blame History

Support Manuscript Compiler logo

Manuscript Compiler is independently maintained. The documentation is the fastest way to resolve common installation, manuscript-structure, formatting, and download questions.

Before requesting help

  1. Read the User Guide, especially its troubleshooting and known-limitations sections.
  2. Confirm the installed main.js, manifest.json, and styles.css came from the same release.
  3. Reproduce the problem with a small synthetic manuscript where possible.
  4. Remove manuscript prose, private metadata, absolute vault paths, account details, and access tokens from anything you share.
  5. Search existing issues and Discussions.

Bug reports

Use the bug report form for a repeatable defect. Include plugin, Obsidian, and operating-system versions; minimal reproduction steps; expected and actual behaviour; and redacted screenshots when useful.

Suspected vulnerabilities do not belong in public issues. Follow the private reporting process in SECURITY.md.

Feature requests

Use the feature request form for a focused, actionable improvement. Explain the author problem before the proposed solution and include alternatives you considered.

Use GitHub Discussions for broader ideas that need community exploration before they can become a scoped issue.

Questions

Check the User Guide first. Use the question form for a focused question with a reproducible context. Once Discussions are enabled, use the Questions category for open-ended help and author-to-author workflow advice.

Discussions

GitHub Discussions is the intended home for author workflows, Show and Tell posts, open-ended ideas, and community questions that are not defects. Until Discussions are enabled, use the structured question or feature-request forms instead.

Documentation

  • User Guide — installation, author workflow, formats, troubleshooting, and limitations
  • Developer Guide — development setup, testing, extension points, and releases
  • Architecture — design boundaries and maintenance rules
  • Security Policy — privacy guarantees and private vulnerability reporting
  • Contributing — contribution standards and pull-request expectations

Report documentation problems with the documentation improvement form.

Expected response times

This project does not provide a guaranteed support service or response-time SLA. When maintainer availability permits, new bug reports and documentation issues are normally triaged within seven days, while questions, feature requests, and Discussions may take up to fourteen days for an initial response. Complex interoperability reports and feature proposals may take longer to assess.

Please do not open duplicate issues or repeatedly mention maintainers to accelerate a response. A lack of immediate response does not mean a report has been rejected.