Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Specify children order in frontmatter #1193

Merged
merged 22 commits into from
Oct 4, 2024
Merged

Specify children order in frontmatter #1193

merged 22 commits into from
Oct 4, 2024

Commits on Oct 3, 2024

  1. Remove impossible page reference from the possible values 

    Page don't and won't use dot references as in `page1.page2`.
    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    704b7d1 View commit details
    Browse the repository at this point in the history

  2. Frontmatter: Parse children order

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    bb05e60 View commit details
    Browse the repository at this point in the history

  3. Link frontmatter by resolving page references

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    14daab2 View commit details
    Browse the repository at this point in the history

  4. Driver: log compile-index in their own list

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    6c78a08 View commit details
    Browse the repository at this point in the history

  5. Allow specification of children order in index page 

    Use

```
children: page1 page2 page3
```

in the frontmatter
    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    b1dcac8 View commit details
    Browse the repository at this point in the history

  6. Children order: do not model that with references 

    Children order specifies order in an index page for the current directory. It
has to specify what is a page and what is a directory, as we can have:

```
doc/
  index
  foo
  foo/
    index
    bar
```

In the specification of the order in `doc/index`, we must make the difference
between the foo page and the foo directory. This was not practical with
references. So instead, the order specification has its own type.
    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    51bd63a View commit details
    Browse the repository at this point in the history

  7. Children order: Add some tests

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    0812abe View commit details
    Browse the repository at this point in the history

  8. Children order: more lax syntax 

    Allow sequences of spaces in a row: `children:      page1           page2`.
    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    4ff50eb View commit details
    Browse the repository at this point in the history

  9. Children order: More improvements to tests

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    c798509 View commit details
    Browse the repository at this point in the history

  10. Children order: compatibility

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    208ee41 View commit details
    Browse the repository at this point in the history

  11. Children order: added changelog entry

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    c10fd76 View commit details
    Browse the repository at this point in the history

  12. Children order review: reduce diff with style improvements 

    Unexpose unnecessary functions
open modules
use mli for model/frontmatter
    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    3ab9782 View commit details
    Browse the repository at this point in the history

  13. Children order: Addressing review comments

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    c405166 View commit details
    Browse the repository at this point in the history

  14. Add a warning when specifying children order in non-index pages 

    Co-authored-by: Jules Aguillon <[email protected]>
    @panglesd @Julow
    panglesd and Julow committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    fa5cf0b View commit details
    Browse the repository at this point in the history

  15. Children order: Refactor sidebar types 

    Directly take children order into account.

Co-authored-by: Jules Aguillon <[email protected]>
    @panglesd @Julow
    panglesd and Julow committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    2ebdf3b View commit details
    Browse the repository at this point in the history

  16. Children order: Add omitted children at the end of the ordering 

    Co-authored-by: Jules Aguillon <[email protected]>
    @panglesd @Julow
    panglesd and Julow committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    26411f7 View commit details
    Browse the repository at this point in the history

  17. Children order: Add a warning when a children is omitted 

    Co-authored-by: Jules Aguillon <[email protected]>
    @panglesd @Julow
    panglesd and Julow committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    2118b0d View commit details
    Browse the repository at this point in the history

  18. Children order: Add warnings for duplicated and unresolved entries

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    eeeffce View commit details
    Browse the repository at this point in the history

  19. Children order: compatibility

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    2a0372f View commit details
    Browse the repository at this point in the history

  20. Do not open Path.Identifier 

    But alias it to Id. It was bringing too many values in scope (eg shadowing
compare).
    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    e4ee1b7 View commit details
    Browse the repository at this point in the history

  21. Compatibility again

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    84d22e3 View commit details
    Browse the repository at this point in the history

  22. Children order: Remove common root using ID not URL segments

    @panglesd
    panglesd committed Oct 3, 2024
    Configuration menu
    Copy the full SHA
    a5db29c View commit details
    Browse the repository at this point in the history