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.

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

[draft] ICP Dev Docs Restructure, Overhaul & Audit #3970

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

Conversation

jessiemongeon1
Copy link
Collaborator

@jessiemongeon1 jessiemongeon1 commented Jan 22, 2025

This PR restructures the ICP Dev Docs and makes several significant changes:

  • Created new documentation categories and top navigation bar sections.
  • Renamed all documentation files to reflect new categories and sections.
  • Removed several pages that will be migrated to new ICP Learn Hub website.
  • Updated and audited all links across all docs pages, internal and external.
  • If a code example used in the docs was originally sourced from the dfinity/examples repo, the code is now referencing the dfinity/examples repo file through a submodule rather than being duplicated in the documentation page.
  • If a code example used in the docs is available from an external GitHub repo, it is now embedded into the page directly via GitHub URL.
  • Audited every docs page for spelling, grammar, and formatting.
  • Applied several style guide revisions for consistency in use of hyphens, terminology, capitalization, etc.
  • Increased Docs Sidebar by 50px to better display long titles.
  • Fixed bug where single pages rendered as bold text on the sidebar.

@jessiemongeon1 jessiemongeon1 requested review from a team as code owners January 22, 2025 19:05
@github-actions github-actions bot added the documentation Changes to Developer Docs label Jan 22, 2025
Copy link

github-actions bot commented Jan 22, 2025

🤖 Preview build failed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes to Developer Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants