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

Website Update: navigational framework, landing page update #1328

Merged
merged 33 commits into from Mar 30, 2022

Conversation

afoxman
Copy link
Contributor

@afoxman afoxman commented Mar 28, 2022

Description

This PR is another update to the rnx-kit documentation web site (which is still a work-in-progress).

It creates the navigational framework of the site:

  • Docs - introductory information, concepts, and "how-to" guides
  • Tools - package-level documentation. version & build/test-status badges, APIs, example usage, link to changelog.
  • Architecture - deep technical knowledge (design), key decisions, motivation, etc.
  • Resources - links to our external media and social networking. links to developer community discussions, newsletters, conferences, etc.
  • Contributing - page dedicated to encouraging community contributions

This PR removes the blog, since there are no posts to share, and my intent is to use a different platform with social features such as like, share, and comment. We can easily reinstate the blog later, if needed, with a few lines of docusaurus config.

This PR also updates the messaging content and styling used on the landing page. I used a bolder font for the title. I chose a shorter, more impactful tagline. I updated the 3 breakout blurbs under the title. And I made the page responsive to different device sizes -- whether you are growing/shrinking your browser, or looking at it on a small-screen device.

I also updated the footer to change during light and dark mode, and I used a better-looking the Microsoft OSS logo image.

Test plan

None.

…g code to fix contrast issues. Change github icon to inline SVG. Add examples of Important and Caution blocks in markdown. Change link colors to match RNW and RN sites.
…einstate homepage feature area, which now appears to be a little broken.
…e code formatting in markdown, color refining/sharing, footer logo size/opacity.
… the box, local search uses Algolia's color scheme and doesn't pick up Docusaurus colors. I have it polished and working, though. Going to try using the DocSearch-based service instead which is supposed to integrate w/Docusaurus CSS vars.
…tter tags and category files, and instead be get name from markdown title and order from sidebar.js.
… sizes. Update MS open source logo with light and dark mode variants in Segoe UI font.
…ame out the remaining pages for V1 of the site and mark with warnings at the top of each page.
@afoxman
Copy link
Contributor Author

afoxman commented Mar 28, 2022

Part of #1255

docsite/docs/resources.md Outdated Show resolved Hide resolved
Copy link
Member

@kelset kelset left a comment

Choose a reason for hiding this comment

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

Overall: great stuff, thanks for working on this! I've left a few comments, mostly just to have some conversations around certain aspects. I don't feel strongly about any of those, and most can be addressed in follow up PRs anyway.


About this:

This PR removes the blog, since there are no posts to share, and my intent is to use a different platform with social features such as like, share, and comment.

Let's have a separate chat about this, I think having a local blog is the option that will most resonate with the developer community and would be in-line with other projects in this space.


Sidenote:

Guides should be step-by-step instructions. Devs use them to complete a task. Doing, not learning.

YES. I like this.

docsite/docs/dependencies.md Show resolved Hide resolved
docsite/docs/dependencies.md Show resolved Hide resolved
docsite/docs/dependencies.md Outdated Show resolved Hide resolved
docsite/docs/packages/overview.md Outdated Show resolved Hide resolved
docsite/docs/resources.md Show resolved Hide resolved
docsite/docs/contributing.md Show resolved Hide resolved
Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>
@afoxman afoxman enabled auto-merge (squash) March 30, 2022 04:51
@afoxman afoxman merged commit 7a22979 into main Mar 30, 2022
@afoxman afoxman deleted the afoxman/docsite2 branch March 30, 2022 05:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants