Updated index.rst to be in adequacy with map.rst.inc #26
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
You cannot removed blank lines. They are needed by the ReST spec. |
|
Ok, I don't see it in the ReST spec. Sorry. What about index.rst file? Are explanations OK for you? |
xabbuh
pushed a commit
that referenced
this pull request
Jul 28, 2016
This PR was merged into the 2.7 branch. Discussion ---------- Deleting index files - using globbing This is a proof-of-concept for part of #26 - removing the `index.rst` and `map.rst.inc` files. I've done this for components only: * `components/index.rst` is NOT hidden, and the map is deleted. This gives us less control over how the components page is rendered... but I don't think it's a problem - that page is/was just a big list of links * `components/index.rst` uses `*` to include *everything* automatically * If you want one article to appear before others with globbing, you can list it before the `*` - see `components/index.rst` * At the bottom of each component article that contains related articles, I added a visible index that globs all the files from its directory (see `console.rst`). I also updated the component titles to include the packagist name on its own commit. Commits ------- dccb6f8 Fix build errors 026be06 Removed topics index pages 26f2f88 Fix wrong redirections de9840b Fix include path 84ee24d Include topics in main Index page bd192fa Fixing bad title 1324fc0 Deleting index files - using globbing
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hi,
This update is due to some inconsistency with current documentation on line and the tag vPR3. It is the same for this documentation.
First inconsistency:
Go to the guide index (http://docs.symfony-reloaded.org/guides/index.html). This one indicates you the content of map.rst.inc file (http://github.com/symfony/symfony-docs/blob/vPR3/guides/map.rst.inc) instead of the content of index.rst file (http://github.com/symfony/symfony-docs/blob/vPR3/guides/index.rst).
Second inconsistency:
Click on the email documentation (http://docs.symfony-reloaded.org/guides/emails.html), go to the bottom of the page to click on next documentation link. The current link is Templating whereas we should have a Validator link as indicated on the index guide.
Hope, you understand what I want to say you.
Bye.