Weave Code
Doc Us Laravel Package
unisharp/doc-us
UniSharp DocUs is a Laravel package for organizing and serving documentation inside your application. It offers a simple way to structure docs, manage content, and keep guides, help pages, and reference material close to your codebase—ideal for teams that want lightweight, self-hosted documentation.
A MySQL Schema Documentation Generator for Laravel.
Frequently asked questions about Doc Us
- How do I install unisharp/doc-us in a Laravel application?
- Install it as a development dependency with composer require --dev unisharp/doc-us, then register the service provider if your Laravel version does not auto-discover it. Point the package at a configured MySQL connection, ideally a sanitized or non-production copy, and run the provided Artisan command to write docs into a directory such as docs/. Confirm the exact command name in the package README before wiring it into scripts, since this is a small utility with limited documentation.
- Which Laravel and PHP versions does unisharp/doc-us support?
- Official constraints are defined in the package's composer.json, so check that file and the README before adopting it. The project is small and low-activity, so it may target older Laravel releases and could need a fork or compatibility patch for Laravel 10 or 11. Run a short spike in a sandbox with your exact Laravel and PHP versions to confirm the command installs and runs. If the constraints conflict with your app, compare against a thin custom Artisan command before investing in a fork.
- Is unisharp/doc-us a runtime dependency or should it be dev-only?
- Treat it as development-only tooling: install with --dev and never rely on it at runtime. It introspects your MySQL schema and writes documentation, so it does not affect application architecture or request handling. Keeping it in require-dev also prevents the package and its transitive dependencies from shipping into production builds.
- What output format does unisharp/doc-us generate, Markdown, HTML, or JSON?
- The package generates schema documentation from your MySQL database, but the exact format should be verified against the README and the command's source before you plan a docs pipeline. Run the command once in a sandbox and inspect the generated files. If the default output does not match your documentation site, you may need to post-process it or extend the generator.
- Does unisharp/doc-us capture foreign keys, indexes, and table relationships?
- Tables and columns are the core of what it documents, but whether foreign keys, indexes, unique constraints, and relationships are captured depends on the package version and should be validated against a schema you know well. Generate docs for a representative database and diff the output against information_schema. If relationship detail is missing, fork the generator or supplement it with a custom introspection command.
- Can I use unisharp/doc-us with PostgreSQL, SQLite, or SQL Server instead of MySQL?
- No. unisharp/doc-us is MySQL-specific, so it will not document PostgreSQL, SQLite, SQL Server, or other engines. For polyglot or non-MySQL stacks, build a custom Artisan command using Laravel's schema builder, Doctrine DBAL, or direct information_schema queries instead.
- How does unisharp/doc-us handle large schemas with hundreds of tables?
- Introspecting several hundred tables is usually fine because the work happens offline in a CLI command, but memory limits and output size grow with schema complexity. Run it against your largest schema in a sandbox and watch for timeouts or truncated output. If needed, run it per connection or per module and commit the generated docs into version control.
- Can I customize the documentation output or extend the generator?
- Check whether the package publishes configuration or views you can override, since small utilities like this often expose limited customization. If your desired output such as branding, section ordering, or extra metadata is not supported, fork the package or wrap it with a post-processing step. Either way, pin the version in composer.json so the generated documentation stays stable between runs.
- How do I automate unisharp/doc-us in CI or keep schema docs up to date?
- Run the Artisan command as a scheduled or on-demand CI job that has access to a sanitized MySQL database, then commit or publish the generated docs. Keep it out of production deploys and never point it at a live database containing sensitive data. Add a review checkpoint on each major Laravel upgrade to confirm the command still runs correctly.
- Is unisharp/doc-us actively maintained, and what are the alternatives if it is abandoned?
- Activity is low, with roughly three dozen GitHub stars, so expect infrequent updates and possible incompatibility with newer Laravel releases; plan to fork or vendor the package if you depend on it. Viable alternatives include a custom Artisan command using Laravel's schema builder or Doctrine DBAL, direct information_schema queries, or general-purpose schema visualization tools. Because it is a dev-only utility, switching costs are low.
Weaver
How can I help you explore Laravel packages today?