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

Feat: DevDocs Revamp #445

Draft
wants to merge 67 commits into
base: master
Choose a base branch
from
Draft

Feat: DevDocs Revamp #445

wants to merge 67 commits into from

Conversation

rossgalloway
Copy link
Collaborator

The devdocs are currently in a state where they are functional and have lots of information on the multiple parts of Yearn, but this information is fragmented and sometimes outdated or inaccurate. The organizational structure is haphazard and reflects the piecemeal way that information has been added over the years. By consolidating, updating, and improving on the docs, there is an opportunity to fill a missing piece of Yearn's information ecosystem: The passive sales and marketing domain that is not captured with the dApp and out of scope of the social channels.

This PR is an effort to streamline and simplify the structure of the docs site so that is easy to use for Users, Developers, and DAO members/contributors.

This PR is not expected to be approved like this as it is going to be hard to review everything. Instead I want to use it as an reference to discuss changes and particular sections and then push individual upgrades and updates to reach this point. There also need to be changes to the content of numerous section of the docs to maximize the impact of these changes and those updated will happen in the aforementioned individual upgrades.

rossgalloway and others added 30 commits June 7, 2024 13:52
@rossgalloway
init
49fcf4d
@rossgalloway
updates
9879f5c
@rossgalloway
Developer Section Re-org
1d6d138
@rossgalloway
init
3f5b6c4
@rossgalloway
Fix issues with existing .md files to allow upgrade to MDX 3
98bc3e1 
change imports to ES modules in config file
fix versioned sidebars to work with docusaurus 3
upgrade react, typescript, and docusaurus to latest versions
@rossgalloway
bump katex and remark math versions to be compatible with v3
b25b160
@rossgalloway
revert linting fixes
bd9b564
@rossgalloway
revert link formatting change
fe7c158
@rossgalloway
add and remove directories
c2c3238
@rossgalloway
oops. now also removed
738cb44
@rossgalloway
update to docusaurus.config
b68328b
@rossgalloway
straight broken
215b3d8
@rossgalloway
mdx fixes but still broken
885c5a2
@rossgalloway
fixed! I think
ae52221
@rossgalloway
collapsed sidebars
74a7262
@rossgalloway
update getting-started sidebar
46410de
@rossgalloway
Squashed commit of the following:
1b5a65f 
commit df43ec6
Merge: a6896d3 21c509c
Author: rossgalloway <[email protected]>
Date:   Tue Jun 18 10:14:44 2024 -0400

    Merge branch 'yearn:master' into v3_updates_rg2

commit a6896d3
Merge: dd48874 38cef0d
Author: rossgalloway <[email protected]>
Date:   Tue Jun 18 10:13:47 2024 -0400

    Merge pull request #6 from Schlagonia/v3_updates

    chore: final edits

commit 38cef0d
Author: Schlagonia <[email protected]>
Date:   Fri Jun 14 10:13:50 2024 -0600

    chore: final edits

commit dd48874
Merge: 54e76ae d1951d2
Author: rossgalloway <[email protected]>
Date:   Wed Jun 12 14:16:29 2024 -0400

    Merge pull request #5 from Schlagonia/v3_updates

    Merge pull request #5 from rossgalloway/v3_updates_rg2

commit d1951d2
Merge: e7cf0e4 54e76ae
Author: Schlag <[email protected]>
Date:   Wed Jun 12 11:55:36 2024 -0600

    Merge pull request #5 from rossgalloway/v3_updates_rg2

    V3 updates rg2

commit 54e76ae
Author: Ross <[email protected]>
Date:   Wed Jun 12 11:30:42 2024 -0400

    * move V3 contract specs into develop folder
    * formatting and linting on contract specs
    * some link fixes
    * split out router periphery contracts
    *split out governance contracts

commit 9a5a203
Merge: 0a71557 e7cf0e4
Author: Ross <[email protected]>
Date:   Wed Jun 12 09:54:01 2024 -0400

    Merge branch 'v3_updates' of https://github.com/Schlagonia/yearn-devdocs into v3_updates_rg2

commit 0a71557
Author: Ross <[email protected]>
Date:   Tue Jun 11 18:26:49 2024 -0400

    move and format smart contract specs

commit e7cf0e4
Author: Schlagonia <[email protected]>
Date:   Mon Jun 10 22:58:34 2024 -0600

    fix: source

commit c244295
Author: Schlagonia <[email protected]>
Date:   Mon Jun 10 22:49:12 2024 -0600

    fix: links

commit abfc75e
Author: Schlag <[email protected]>
Date:   Tue Jun 11 21:07:38 2024 -0600

    Update vaults/smart-contracts/v3/periphery/DebtAllocator.md

    Co-authored-by: rossgalloway <[email protected]>

commit 0bef26d
Author: Schlag <[email protected]>
Date:   Tue Jun 11 21:07:30 2024 -0600

    Update vaults/smart-contracts/v3/periphery/AprOracle.md

    Co-authored-by: rossgalloway <[email protected]>

commit 66724b0
Author: Schlag <[email protected]>
Date:   Tue Jun 11 21:07:19 2024 -0600

    Update vaults/smart-contracts/v3/periphery/Auction.md

    Co-authored-by: rossgalloway <[email protected]>

commit 619e557
Author: Schlag <[email protected]>
Date:   Tue Jun 11 21:07:09 2024 -0600

    Update vaults/smart-contracts/v3/periphery/CommonReportTrigger.md

    Co-authored-by: rossgalloway <[email protected]>

commit 6c2277e
Author: Schlag <[email protected]>
Date:   Tue Jun 11 21:06:54 2024 -0600

    Update vaults/smart-contracts/v3/periphery/ReleaseRegistry.md

    Co-authored-by: rossgalloway <[email protected]>

commit f85bd64
Author: Schlag <[email protected]>
Date:   Tue Jun 11 21:06:42 2024 -0600

    Update vaults/smart-contracts/v3/TokenizedStrategy.md

    Co-authored-by: rossgalloway <[email protected]>

commit b4794ed
Author: Schlag <[email protected]>
Date:   Tue Jun 11 21:06:25 2024 -0600

    Update vaults/smart-contracts/v3/TokenizedStrategy.md

    Co-authored-by: rossgalloway <[email protected]>

commit c38066d
Author: Schlagonia <[email protected]>
Date:   Mon Jun 10 21:36:06 2024 -0600

    fix: links

commit fbae648
Author: Schlagonia <[email protected]>
Date:   Mon Jun 10 16:08:39 2024 -0600

    feat: vyper contracts

commit d70c2ce
Merge: 08c82fc 189c394
Author: Schlagonia <[email protected]>
Date:   Mon Jun 10 15:54:16 2024 -0600

    Merge branch 'v3_updates' of https://github.com/Schlagonia/yearn-devdocs into v3_updates

commit 189c394
Merge: b403063 4bf7521
Author: Schlag <[email protected]>
Date:   Mon Jun 10 16:23:07 2024 -0600

    Merge pull request #4 from rossgalloway/v3_updates_rg

    improved code blocks

commit 08c82fc
Author: Schlagonia <[email protected]>
Date:   Mon Jun 10 15:54:09 2024 -0600

    feat: add solc natspec

commit 4bf7521
Author: Ross <[email protected]>
Date:   Mon Jun 10 17:23:46 2024 -0400

    improved code blocks

commit b403063
Merge: 15c798f fe7485d
Author: Schlag <[email protected]>
Date:   Mon Jun 10 14:30:32 2024 -0600

    Merge pull request #3 from rossgalloway/v3_updates_rg

    debug: change `throw` to `warn` on broken links

commit fe7485d
Author: Ross <[email protected]>
Date:   Mon Jun 10 16:19:20 2024 -0400

    debug: change `throw` to `warn` on broken links

commit 15c798f
Merge: b38c1ab c56e269
Author: Schlag <[email protected]>
Date:   Mon Jun 10 13:41:58 2024 -0600

    Merge pull request #2 from rossgalloway/v3_updates_rg

    V3 updates rg

commit c56e269
Author: Ross <[email protected]>
Date:   Mon Jun 10 13:02:01 2024 -0400

    fix links, other minor changes.

commit e5f9e7e
Merge: cea0304 73a7b17
Author: Ross <[email protected]>
Date:   Mon Jun 10 11:44:46 2024 -0400

    Merge branch 'v3_updates_rg' of https://github.com/rossgalloway/yearn-devdocs into v3_updates_rg

commit cea0304
Author: Ross <[email protected]>
Date:   Mon Jun 10 11:41:37 2024 -0400

    fix links

commit 73a7b17
Merge: e0c3132 b38c1ab
Author: rossgalloway <[email protected]>
Date:   Mon Jun 10 11:41:11 2024 -0400

    Merge pull request #2 from Schlagonia/v3_updates

    pull in updates

commit b38c1ab
Author: Schlagonia <[email protected]>
Date:   Mon Jun 10 09:27:49 2024 -0600

    chore: sidebar

commit 5f69c10
Author: Schlagonia <[email protected]>
Date:   Mon Jun 10 09:26:18 2024 -0600

    feat: add links

commit e0c3132
Merge: d1bfff7 983fa5b
Author: rossgalloway <[email protected]>
Date:   Mon Jun 10 11:16:27 2024 -0400

    Merge pull request #1 from Schlagonia/v3_updates

    V3 updates

commit 983fa5b
Merge: 7b0f4cc c061e49
Author: Schlag <[email protected]>
Date:   Mon Jun 10 08:49:00 2024 -0600

    Merge branch 'master' into v3_updates

commit d1bfff7
Merge: f88897e c061e49
Author: Ross <[email protected]>
Date:   Fri Jun 7 14:29:12 2024 -0400

    Merge branch 'v3_updates_rg' of https://github.com/rossgalloway/yearn-devdocs into v3_updates_rg

commit 7b0f4cc
Merge: 77ac139 f88897e
Author: Schlag <[email protected]>
Date:   Fri Jun 7 09:43:20 2024 -0600

    Merge pull request #1 from rossgalloway/v3_updates_rg

    edits to schlag V3 edits pull request

commit f88897e
Author: Ross <[email protected]>
Date:   Thu Jun 6 17:30:13 2024 -0400

    edits to schlag V3 edits pull request

commit 77ac139
Author: Schlagonia <[email protected]>
Date:   Thu Jun 6 10:42:11 2024 -0600

    fix: feedback

commit 8799b1c
Author: Schlagonia <[email protected]>
Date:   Thu Jun 6 10:34:54 2024 -0600

    feat: v3 updates
@rossgalloway
update sidebar and titles for v3 contracts
3425d1d
@rossgalloway
Merge commit '1d6d138f70961e15b5342f5a2d4626864b00685d' into remove-v…
74d5482 
…ersioning-update-structure
@rossgalloway
more site structure updates
39ca220
@rossgalloway
working on links and v1 addition
4d78089
@rossgalloway
Merge remote-tracking branch 'origin/master' into remove-versioning-u…
4be6d61 
…pdate-structure
@rossgalloway
fix sidebars
0036ec2
@rossgalloway
add v1 smart contract specs to nav
400a5e1
@rossgalloway
working on sidebar issues
ddc8aaf
@rossgalloway
remove using-yearn to fix merge issue
07ffead
@rossgalloway
Merge branch 'yearn:master' into remove-versioning-update-structure
575195e
@rossgalloway
fix focus in navbar
7fc13c7
@rossgalloway
added:
19ea2eb 
- yearn principals
- new risk page
- moved yearn stack page
- updated sidebars
@rossgalloway
update:
5af0625 
add update warning to 'building on yearn'
add placeholder page for 'wallet integrations'
separate FAQ in yETH page
add placeholder yVaults faq page.
update sidebars
This was referenced Aug 1, 2024
Merged
Merged
@rossgalloway rossgalloway mentioned this pull request Aug 14, 2024
Merged
@rossgalloway
Copy link
Collaborator Author

This is the messy reference implementation of changes to be made to the devdocs site.

Changes since the presentation in the cantina:

  • Added new "yearn" admonition to use as a callout
  • New Diagrams for V2 and V3 vaults
  • simplify user docs for vaults, push technical data into dev docs
  • remove yearn.watch from docs. see: fe05460
  • Update site font to use Aeonik to match yearn brand
  • edit font sizing
  • remove "Yearn.Finance" title and just use logo
  • some sidebar updates:
    • simplify "yearn products section" by adding yPools, moving yBribe to Deprecated and veYFI to dao docs
    • add deprecated projects to user docs sidebar
    • give deprecated projects its own sidebar

@rossgalloway rossgalloway mentioned this pull request Aug 20, 2024
Merged
This was referenced Aug 22, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@rossgalloway