Home

Welcome to the devdocs-theme wiki!

Important notes

Updates

1. Avoid changes to the @spectrum-css packages because they can introduce unexpected changes in the UI as well as backward changes, which takes quite a while to be investigated and resolved. If you have to update the packages, always test any changes such as TOCs, main navigation, tables, headings, buttons in tutorials, notes, the search form. If you find any new issues that do not appear on production, check out the (https://opensource.adobe.com/spectrum-css/index.html) for breaking changes such as a new mandatory class was added or the affected package or class was renamed.
2. Typically, updates by Dependabot affect only the development environment and will not break production deployment. Run each npm task to make sure nothing was broken in the development environment.
3. To update the theme within a doc site (devdocs, merchdocs, oms-docs, merchdocs-mbi, pwa), run rake update:theme there.
4. Bump the theme version for major updates and updates in Spectrum dependencies. Search places to bump the version: ?ver, spec.version

Linting

It is possible that a linting check fails with a lot of errors even though you introduced a very small update to a file. This happens because our linters are adjusted to run only on changed files. When you change a file that hasn't been linted yet, it will very probably find a lot of issues there.

How to resolve

Every linting report starts from a message that contains the name of the linter. Many of them allow auto fixing for small violations. Typically, you just search for the linter's documentation, install it locally, and run auto fixing on the file that failed the GitHub check. Example: standard --fix _js/search.js

Other

1. Each project's background is rendered from a project's assets/i/home-bg.jpg