Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Increase visibility of codec and db docs #1387

Open
kevinbluer opened this issue Jan 11, 2023 · 1 comment
Open

Increase visibility of codec and db docs #1387

kevinbluer opened this issue Jan 11, 2023 · 1 comment
Labels
documentation Issues related to documentation enhancement priority2 ⚠️

Comments

@kevinbluer
Copy link
Member

kevinbluer commented Jan 11, 2023 •
edited
Loading

Details

Currently, the codec and db (Typedoc generated) docs have no visibility from within the rest of the site. Let's change that 🙂

One option could be to add them to the left-hand navigation (via a .pages entry), possibly under "Reference":

Screenshot 2023-01-10 at 8 05 38 PM

As part of this let's also include a redirect from /docs/codec to the correct location, given this was previously (albeit incorrectly) in place.
@lsqproduction lsqproduction added the documentation Issues related to documentation label Jan 12, 2023
@cliffoo
Copy link
Contributor

cliffoo commented Jan 12, 2023

The docs should link back to trufflesuite.com also.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Issues related to documentation enhancement priority2 ⚠️
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kevinbluer @lsqproduction @cliffoo