-
-
Notifications
You must be signed in to change notification settings - Fork 418
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
[docs] document new config values #1562
Conversation
8686e12
to
7089e15
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is correct. Thanks Jesse!
If we assume that the doc of this bundle will always be a single page (which I think it's safe to assume) then you could simplify some things if you want:
- You could remove the
disable-cache
option because when having 1 doc page, it doesn't make any noticeable difference - All the logic related to this --> "fix assets URLs to make them absolute (otherwise, they don't work in subdirectories)" could be removed because you don't have images and, if you include images in the future, you won't have subdirectories for contents because all the docs are in a single page
A final comment: something very useful for us is to run a RST linter to docs. It detects so many issues! We use DOCtor-RST (created by @OskarStark and actively developed by folks like @alamirault). We use it like this:
otherwise I wont know what `::` means 6 months from now...
ea52dd3
to
ab26e21
Compare
Yup - totally stole the code from https://github.com/symfony/symfony-docs/tree/7.1/_build to preview the build
Open to ideas on how we can preview the docs that ultimately get published on symfony.com without doing the whole "make change -> merge PR" rinse and repeat cycle...