Support --config flag to specify config file #472
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added Ability to use different configs
This pull request is the quickest route to "multiple documentation areas"
Preparation
copy config/scribe.php to another config name e.g config/scribe_admins.php
its at the users discression how they generate the docs but I found static with my own controller way more useful
here are the config options I used
Usage
php artisan scribe:generate --config=scribe_admins
Notes
I know these is a very very small amount of work added and I'm sure there is more that could be added to make this more functional and smooth but just adding this option has helped me out a massive amount and I feel it could be a massive feature for so many people using this package.
for me the simplest route was to add a second static config like scribe_admins and have add my own routes and controllers to handle serving these generated assets.
like so:
known issues
Assets are a bit of a tricky one with static doc generation, there are so many ways around this, but my quickest fix was to add them on the fly if they didn't exist in the controller like so.
Also I looked for the docs folder so I could contribute to the documentation without such luck?
Known Issues / Tickets
#471
the Commits
sorry about the mess I added an ability to use ignore_hidden which I needed to undo in my master branch in order to send this PR.