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

Update docs navbar #838

Merged
merged 12 commits into from Dec 13, 2023
Merged

Update docs navbar #838

merged 12 commits into from Dec 13, 2023

Conversation

martriay
Copy link
Contributor

@martriay martriay commented Dec 2, 2023

Fixes #749. Work in progress.

@martriay
Copy link
Contributor Author

martriay commented Dec 6, 2023 •
edited

Comment by @ericnordelo:

Looking better already! A couple of comments:

  • I think the Wizard should be right after Overview because it is a powerful tool and people can easily miss it this way.
  • I would remove the See Also section if it contains only the Contracts for Solidity entry.
  • If we have Learn and Modules, we should avoid collapsing all the sections by default IMO, and leave at least these two open by default (UI)

@martriay
Copy link
Contributor Author

martriay commented Dec 13, 2023 •
edited

  • I think the Wizard should be right after Overview because it is a powerful tool and people can easily miss it this way.

👍

  • I would remove the See Also section if it contains only the Contracts for Solidity entry.

👍

  • If we have Learn and Modules, we should avoid collapsing all the sections by default IMO, and leave at least these two open by default (UI)

The setting is global and I couldn't fine a more granular way of doing it. If I remove the auto-collapse, every level (down to API pages) gets expanded and it looks really bad.

image

@martriay martriay marked this pull request as ready for review December 13, 2023 04:45
@ericnordelo
Copy link
Member

The setting is global and I couldn't fine a more granular way of doing it. If I remove the auto-collapse, every level (down to API pages) gets expanded and it looks really bad.

You can change this line in antora.yml:

page-sidebar-collapse-default: true

to

page-sidebar-collapse-default: 'Access Control,Accounts,Introspection,Security,Tokens,ERC20,ERC721,Upgrades'

I know it is a little verbose, but I think it should work. I could create a PR to the docsite repo with another option for specifying open sections instead of collapsed ones by default, but in the meantime, we can have this.

ericnordelo
ericnordelo reviewed Dec 13, 2023
View reviewed changes
Copy link
Member

@ericnordelo ericnordelo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking fantastic! Besides the suggestion for collapsing I left in a comment, it looks ready to go to me!

@martriay
Copy link
Contributor Author

The setting is global and I couldn't fine a more granular way of doing it. If I remove the auto-collapse, every level (down to API pages) gets expanded and it looks really bad.

You can change this line in antora.yml:

page-sidebar-collapse-default: true

to

page-sidebar-collapse-default: 'Access Control,Accounts,Introspection,Security,Tokens,ERC20,ERC721,Upgrades'

I know it is a little verbose, but I think it should work. I could create a PR to the docsite repo with another option for specifying open sections instead of collapsed ones by default, but in the meantime, we can have this.

This is what I wanted! Thanks, couldn't find it in the docs (and searched for the page-sidebar-collapse-default setting specifically, even in their repo). How did you find it? Fixed it btw.

@ericnordelo
Copy link
Member

This is what I wanted! Thanks, couldn't find it in the docs (and searched for the page-sidebar-collapse-default setting specifically, even in their repo). How did you find it? Fixed it btw.

That is a custom attribute with custom logic in our docsite repo, and I remembered a commit I saw from fran a little ago, so I looked for it, and found this PR with a very nice description of the feature.

ericnordelo
ericnordelo approved these changes Dec 13, 2023
View reviewed changes
Copy link
Member

@ericnordelo ericnordelo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

andrew-fleming
andrew-fleming approved these changes Dec 13, 2023
View reviewed changes
Copy link
Collaborator

@andrew-fleming andrew-fleming left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fantastic, Marto! :)

I left a small question, but I think it's good to go!

docs/modules/ROOT/nav.adoc Show resolved Hide resolved
@martriay martriay merged commit e7f63bb into main Dec 13, 2023
5 checks passed
@martriay martriay deleted the new-docs-navbar branch December 13, 2023 14:14
martriay added a commit that referenced this pull request Dec 13, 2023
@martriay @andrew-fleming @ericnordelo
Update v0.8.0 docs (#854)
6f72a52 
* bump to 0.8.0 (#834)

* Update PULL_REQUEST_TEMPLATE.md (#827)

* Update PULL_REQUEST_TEMPLATE.md

* Update PULL_REQUEST_TEMPLATE.md

* Update PULL_REQUEST_TEMPLATE.md

* Update RELEASING and CONTRIBUTING (#828)

* update RELEASING

* fix linting

* update CONTRIBUTING

* fix emphasis

* add changelog to releasing.md

* improve live testing guidelines

* Update CONTRIBUTING.md

Co-authored-by: Andrew Fleming <fleming-andrew@protonmail.com>

---------

Co-authored-by: Andrew Fleming <fleming-andrew@protonmail.com>

* Add `ERC721ABI` and fix other abis (#761)

* fix account abi

* fix erc20 abi

* fix erc721 abi

* reorder internal fns

* reorder internal fns

* fix comment

* reorder fns

* fix casing

* fix casing

* reorder api fns

* add dual interfaces link

* add camel methods to api

* remove imports

* re-add src5_state

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>

* add deployer trait/impl

* change non-standard to impls in fn list

* fix in-code doc style

* fix comments

* fix interface order

* remove unused impl

---------

Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>

* Update utility docs  (#825)

* fix: link (#545)

* feat: add utility docs

* Update docs/modules/ROOT/pages/utilities.adoc

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* Update docs/modules/ROOT/pages/utilities.adoc

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* Update docs/modules/ROOT/pages/utilities.adoc

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* feat: apply review updates

* Update docs/modules/ROOT/pages/utilities.adoc

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* feat: apply review updates

* fix: remove drop events

* feat: update CHANGELOG

* feat: apply review udpates

---------

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* Add in-code docs (#822)

* add in-code comment

* normalize in-code comments

* fix comment

* fix comments

* fix comments

* add double back ticks for comment possessives

* add missing reqs

* add missing reqs, fix _burn description

* fix __execute__ reqs

* remove double backticks

* remove unused imports

* fix: implementation name (#840)

* Improve component tests with ComponentState (#836)

* refactor: component state in tests

* feat: update CHANGELOG

* Update CHANGELOG.md

Co-authored-by: Martín Triay <martriay@gmail.com>

* feat: apply review updates

* fix: CHANGELOG

---------

Co-authored-by: Martín Triay <martriay@gmail.com>

* Document SRC5 migration (#821)

* start migration guide

* add links, add register_interfaces example

* add supports_interfaces

* add supports_interfaces to docs

* fix formatting

* revert change

* Apply suggestions from code review

Co-authored-by: Martín Triay <martriay@gmail.com>

* remove upgrade fn from code block

* remove supports_interfaces

* add deregister_erc165_interface

* change src5 migration title

* fix src5 migration doc

* fix how-to section

* fix formatting

* add deregister_erc165_interface

* update interface registration section

* add link to register_interface

* update CHANGELOG

* Apply suggestions from code review

Co-authored-by: Martín Triay <martriay@gmail.com>

* remove register_erc165_interface

* remove deregister_erc165_interface from utilities

* remove deregister from guide

* fix import

* remove register_interfaces fn from API

* remove unused var

* add initializable warning

---------

Co-authored-by: Martín Triay <martriay@gmail.com>

* Document Class Hashes (#832)

* fix: link (#545)

* feat: add page

* feat: finish UI

* Update docs/modules/ROOT/pages/api/erc721.adoc

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>

* feat: apply review updates

* fix: remove trailing space

* feat: update CHANGELOG

* Update CHANGELOG.md

Co-authored-by: Martín Triay <martriay@gmail.com>

* feat: apply review updates

* feat: apply review updates

---------

Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Co-authored-by: Martín Triay <martriay@gmail.com>

* Update extensibility docs (#823)

* add extensibility docs

* start setup guide

* change file name

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>

* fix name

* change title

* change title to component impl

* update changelog

* add comp storage section

* finish new structure

* finish edits, add customization section

* simplify titles

* finish custom impl section

* Apply suggestions from code review

Co-authored-by: Martín Triay <martriay@gmail.com>

* fix comp storage section

* change section title  to setup, minor edits

* add cmp storage link, clean up impl section

* add cairo book link

* add api design tip

* Apply suggestions from code review

---------

Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>
Co-authored-by: Martín Triay <martriay@gmail.com>

* Update docs navbar (#838)

* update docs navbar

* complete navbar

* fix navbar

* fix navbar

* update changelog

* update changelog

* fix changelog

* update wizard and rename usage -> components

* fix broken links

* reordered changelog

* fix default collapsed sections

---------

Co-authored-by: Andrew Fleming <fleming-andrew@protonmail.com>
Co-authored-by: Eric Nordelo <eric.nordelo39@gmail.com>
Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericnordelo ericnordelo ericnordelo approved these changes

@andrew-fleming andrew-fleming andrew-fleming approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Rethink main docsite navbar
3 participants
@martriay @ericnordelo @andrew-fleming