Merge in branch for recursive navigation #1
Merged
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
- Update `_config.yml` to add plugin `jekyll-include-cache` and option `nav_cache`.
- Update `just-the-docs.gemspec` to add `jekyll-include-cache`.
- Add `_nav_cache_false.yml` to disable caching (for profiling).
- Add `_include_tests.yml` to include `docs/tests/`.
- Replace `_includes/nav.html` by `_includes/nav/*.html`.
- Update `_layouts/default.html` to include `nav/{main,crumbs,toc}.html`.
Run jekyll with option `--config _config.yml,_include_tests.yml` to check unchanged.
- Major update for recursive navigation. - Explain disambiguation by ancestor and section id. - Move notes for users of previous versions to footnotes.
- Move regression tests from `docs/tests` to `_tests`. - Update `_config.yml` and `_include_tests.yml`. - Configure front matter default layout for tests. - Simplify navigation for tests using recursive navigation. - Add tests for title disambiguation. Run jekyll with option `--config _config.yml,_include_tests.yml` to check.
The regression tests have been expanded, and the navigation hierarchy is deeper.
- Update the site title to show the fork branch name. - Needs to be reverted if merged.
- Update `url` to fix the internal links on the published site. - Needs to be reverted if merged.
- Rename `_include_tests.yml` to `_tests.yml`.
- Fix the check that the `ancesstor` title is in the path by enclosing it in a pair of "^"s, and changing the extension of the path to append the "^". - Add regression tests with overlapping titles to show that ancestors are now strictly checked using the separators. To do: - Titles are assumed not to contain "^", which is used to separate titles in paths. Replace "^" by newline, which cannot occur in a title.
- Check that the grandchildren with incorrect ancestor fields now appear.
- Change the separator used in navigiation paths from `^` to newline. - Add regression tests to check that ancestor titles do not match prefixes or suffixes.
- Add `_config_dev.yml` - Relax gem version constraints
- Invert a condition in the test for top-level pages This avoids the navigation for non-collection pages disappearing when there are no child pages.
splittingred
approved these changes
Jan 22, 2021
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.
Merges this PR into our fork in order to support recursive (and therefore arbitrary depth) navigation.
In planning out what documentation we want for Payments a deeper navigation structure would be useful for providing a clearer hierarchy of pages. However we're limited to 3 levels with the current implementation and two of those are taken up just by
Domains -> Paymentsleaving us no real space to do anything. I feel like this will become a more of an issue as teams add more documentation.Additionally, it seems to decrease the generation time. On my local it's down to ~30 seconds from > 90 seconds previously. Presumably because of the new caching gem?
Ping @splittingred for any input 🙏