Граф коммитов

15 Коммитов

Автор SHA1 Сообщение Дата
Tommy Nguyen e9665e0927
docs: replace Algolia with offline search (#3358) 2024-09-17 08:18:05 +02:00
Tommy Nguyen bc4aa3c8fd
chore: address Dependabot alerts (#3191) 2024-06-14 16:32:31 +02:00
Lorenzo Sciandra c42fecdb7f
Clean and clarify the docs (#2713)
Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>
2023-09-29 12:55:14 +02:00
Tommy Nguyen 19601108b7
docs: bump typescript to 5.0.2 (#2325) 2023-04-14 08:54:09 +02:00
Tommy Nguyen 9f24106cda
docs: automate removal of badges from READMEs (#2324) 2023-04-14 08:24:28 +02:00
Tommy Nguyen 6b0feb2aca
docs: generate Tools sidebar (#2294) 2023-03-27 17:24:28 +02:00
Lorenzo Sciandra 3a2af2e865
chore(website): remove local blog in favour of the DevBlog (#2045) 2022-11-28 10:05:07 +00:00
Adam Foxman f75aa7ece3
Use Algolia DocSearch as the search provider for our website (#1523)
* Move from a local-search plugin to an internet-based search crawler called Algolia DocSearch. This is the standard search system for Docusaurus.

* docs(changeset):
2022-05-18 07:58:27 -07:00
Adam Foxman 9455c59e18
Fix twitch link, set up google analytics (#1457)
* Fix twitch link, set up google analytics

* docs(changeset):

* fix homepage accessibility

* fix timeout flakiness for long-running tests
2022-05-03 16:09:34 -07:00
Adam Foxman d2d429cd75
Website publishing, root README update (#1455)
* experimenting with readme file

* update readme

* Configure docsite for GitHub pages

* Update PR and Build loops to build and publish the website.

* fix typo

* docs(changeset):
2022-05-03 12:35:33 -07:00
Adam Foxman 90fd005aae
Website Update (#1439)
* Final draft of getting started

* Final draft of introduction page

* Update menu and tab styling.

* update vscode recommended extension list to include markdown

* formatting

* minor language/tone update

* Add a note about meta capabilities

* refine intro of getting started guide

* Add prettier formatting for MDX files.

* Refine getting started page. Factor out code and text fragments which are useful on other pages.

* fix link styling in admonition blocks

* write the depenedency management how-to guide

* Darken the background for light-mode inline "code" blocks

* docs(changeset): Another round of additions and refinments to the documentation website.

* further refine light-mode code-box shadows

* Add missing "tool for that" link

* Update type-safety to show new "moduleSuffixes" option in version 4.7.

* Minor tweaks to dependency-management guide. Remove unneeded includes. Text polish. Fix link to PR page in rnx-kit.

* Add a guide on bundling. Include placeholder pages for some tools which the bundling guide links to.

* Add placeholder pages to left nav.

* Fix tree shaking references. Don't use the hyphen.

* docs(changeset): Fix references to tree shaking. Remove the hyphen.

* docs(changeset): Add bundling guide. Polish existing web pages. Add placeholder pages for some tools packages (needed by bundling guide).

* remove old change file

* Start with all side-bar categories expanded to make content more discoverable.

* Remove warning banner

* Add arch overview page. Add dep-check arch page (material from dep-check README and DESIGN files). Add empty dep-check tool page, since it is referenced in dep-check arch page.

* Make the code of conduct more approachable by using sentences instead of bullet points.

* Copy and polish the text from Contributing.md to the website. Once the site goes live, the contributing page will be a mostly-empty redirect to the site. The site has better rendering capabilities, and will generate a side-nav rather than relying on a TOC at the top of the document.

* Add a resources page. Also add an "image with text" for that page. Fix link styling so its less restrictive. Add twitter logo.

* fix changeset

* Remove hyphen from pull request.

* Remove links which don't add value to the current article/guide (e.g. they can be googled easily, as needed). Keep links to content that is not covered but critically important. Also, keep links that refer to the rnx-kit repo.

* Remove unneeded outbound links

* PR feedback

* Remove old changesets

* Re-add changefiles

* update change files

* use code-block titles instead of top-line comments in dependency management arch doc

* Create a docusaurus plugin which lets us process markdown files in the monorepo, outside of the docsite project. Create an MDX plugin to remove ranges of markdown based on start/end comments, and add that plugin to the docusaurus plugin.

* Add a website page for each publish package's README. Exclude the badges and title. Replace the title with the package name, but without @rnx-kit (which crowds out the left nav).

* Change README-include approach from using JSX imports to using a remark plugin.

* Fix plugin paths. Update contributing so it appears in both the normal location in the source tree and on the web site.

* Change styling for selected left-nav items. Stop using bold as it changes the text-width significantly, causing a shift in the word-wrapping.

* Update the tools and architecture overview pages. Move all tools pages from a 'packages' parent dir to a 'tools' parent dir.

* Refine resources page. Add discord profile link

* Tweak the text at the top of the getting started page

* Add the first blog post announcing the launch

* docs(changeset): Website and README updates

* Change file

* Update docsite/src/components/Image.tsx

Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>

Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>
2022-05-02 15:03:22 +00:00
Adam Foxman e9058568b6
Website Update (#1424)
* Final draft of getting started

* Final draft of introduction page

* Update menu and tab styling.

* update vscode recommended extension list to include markdown

* formatting

* minor language/tone update

* Add a note about meta capabilities

* refine intro of getting started guide

* Add prettier formatting for MDX files.

* Refine getting started page. Factor out code and text fragments which are useful on other pages.

* fix link styling in admonition blocks

* write the depenedency management how-to guide

* Darken the background for light-mode inline "code" blocks

* docs(changeset): Another round of additions and refinments to the documentation website.

* further refine light-mode code-box shadows

* Add missing "tool for that" link

* Update type-safety to show new "moduleSuffixes" option in version 4.7.

* Minor tweaks to dependency-management guide. Remove unneeded includes. Text polish. Fix link to PR page in rnx-kit.

* Add a guide on bundling. Include placeholder pages for some tools which the bundling guide links to.

* Add placeholder pages to left nav.

* Fix tree shaking references. Don't use the hyphen.

* docs(changeset): Fix references to tree shaking. Remove the hyphen.

* docs(changeset): Add bundling guide. Polish existing web pages. Add placeholder pages for some tools packages (needed by bundling guide).

* remove old change file

* Start with all side-bar categories expanded to make content more discoverable.

* Remove warning banner

* fix changeset

* Remove hyphen from pull request.

* Remove links which don't add value to the current article/guide (e.g. they can be googled easily, as needed). Keep links to content that is not covered but critically important. Also, keep links that refer to the rnx-kit repo.

* Remove unneeded outbound links

* PR feedback
2022-04-27 09:42:45 +02:00
Adam Foxman ac38af7b4d
Upgrade docusaurus, fix light-mode code-block styling (#1415)
* Upgrade docusaurus. Change code-block theme to vsLight when in light mode, and fix the font-color and shadows so the code stands out.

* docs(changeset): Upgrade Docusaurus. Change code-block theme to vsLight when in light mode, and fix the font-color and shadows so the code stands out.
2022-04-21 20:52:05 +02:00
Adam Foxman 7a22979d8a
Website Update: navigational framework, landing page update (#1328)
* working docusaurus site. mostly stock with a few minor tweaks.

* set light/dark mode colors

* Update README main header link. Add GitHub logo (light and dark mode variants) to docsite header bar.

* accessibility fixes

* Clear out footer, leaving copyright. Always use darktheme when showing 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.

* Move into doc into hierarchy (styles don't support top-level docs). Reinstate homepage feature area, which now appears to be a little broken.

* Add MS Open Source img and link as footer logo. Also tweak CSS: inline code formatting in markdown, color refining/sharing, footer logo size/opacity.

* Remove opacity styles on footer -- they happen automatically since it is a link.

* Finalize landing page. Move GitHub logo into an .svg file.

* Fix editUrls.

* fix homepage text

* Add local-search support and styling. Not too happy with this. Out of 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.

* Update docusaurus version

* Create navbar hierarchy and matching sidebars. Remove inline front-matter tags and category files, and instead be get name from markdown title and order from sidebar.js.

* Use a very dark gray background instead of black in darkmode. Fix typo in navbar.

* add shadow on navbar in darkmode

* Starting to put together content for docsite from READMEs.

* Merge main

* Refine landing page message. Add "resources" and "contributing" sections in the top nav bar.

* Tweak home page styles. Make home page responsive at different device sizes. Update MS open source logo with light and dark mode variants in Segoe UI font.

* Adjust responive home page spacing

* Update landing page

* Write pages: The Basisc > Introduction, The Basics > Dependencies. Frame out the remaining pages for V1 of the site and mark with warnings at the top of each page.

* Add intro page on type safety

* remove demo content

* undo unrelated changes

* remove unused svg

* docs(changeset): Update navigation and landing page

* Update docsite/docs/resources.md

Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>

* Fix grammar

* Adjust note about incubating packages on package-overview page.

* Add note to consolidate contributing site page and contributing.md

Co-authored-by: Tommy Nguyen <4123478+tido64@users.noreply.github.com>
2022-03-30 05:09:05 +00:00
Adam Foxman ee96c012a4
Documentation Website (#1197)
* working docusaurus site. mostly stock with a few minor tweaks.

* set light/dark mode colors

* Update README main header link. Add GitHub logo (light and dark mode variants) to docsite header bar.

* accessibility fixes

* Clear out footer, leaving copyright. Always use darktheme when showing 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.

* Move into doc into hierarchy (styles don't support top-level docs). Reinstate homepage feature area, which now appears to be a little broken.

* Add MS Open Source img and link as footer logo. Also tweak CSS: inline code formatting in markdown, color refining/sharing, footer logo size/opacity.

* Remove opacity styles on footer -- they happen automatically since it is a link.

* Finalize landing page. Move GitHub logo into an .svg file.

* Fix editUrls.

* fix homepage text

* Add local-search support and styling. Not too happy with this. Out of 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.

* Update docusaurus version

* Create navbar hierarchy and matching sidebars. Remove inline front-matter tags and category files, and instead be get name from markdown title and order from sidebar.js.

* Use a very dark gray background instead of black in darkmode. Fix typo in navbar.

* add shadow on navbar in darkmode

* Remove sample content

* docs(changeset): Documentation site framework and theming. No content yet other than the landing page.

* yarn deduplicate

* update dup checker tests -- they are sensitive to the yarn dependency graph in this repo

* align dependencies
2022-03-08 18:30:14 +01:00