You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The main purpose of the process-asciidoc goal is to find and convert AsciiDoc files. However, it's not immediately clear, especially to new users, which files the goal selects. This information is tucked away in an admonition block in the documentation for the sourceDirectory property. I think it would be better if this information were to be moved to either the preamble or a dedication section that follows it.
This new paragraph should explain that the goal will automatically discover AsciiDoc files that ends with .adoc (other extensions too?) in the specified sourceDirectory and convert them. It can then emphasize that the goal ignores files that are considered non-public, such as internal include files and hidden files. The reason these files are excluded is so that they can be put there to reference using the include directive without being converted separately.
The text was updated successfully, but these errors were encountered:
Category: Documentation enhancement
The main purpose of the process-asciidoc goal is to find and convert AsciiDoc files. However, it's not immediately clear, especially to new users, which files the goal selects. This information is tucked away in an admonition block in the documentation for the sourceDirectory property. I think it would be better if this information were to be moved to either the preamble or a dedication section that follows it.
This new paragraph should explain that the goal will automatically discover AsciiDoc files that ends with .adoc (other extensions too?) in the specified sourceDirectory and convert them. It can then emphasize that the goal ignores files that are considered non-public, such as internal include files and hidden files. The reason these files are excluded is so that they can be put there to reference using the include directive without being converted separately.
The text was updated successfully, but these errors were encountered: