Skip to content

Commit

Permalink
Fixing links
Browse files Browse the repository at this point in the history
  • Loading branch information
TimRoe committed Jan 24, 2024
1 parent e463faa commit a2b02fd
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# VA Mobile Libraries

See the [Design System section of the VA Mobile documentation site](https://department-of-veterans-affairs.github.io/va-mobile-app/design/Intro) for the most organized form of the documentation. The [engineering documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/For%20engineers/overview) there also exists in this repo either in the `documentation` folder or as `README`'s tied to particular packages.
See the [Design System section of the VA Mobile documentation site](https://department-of-veterans-affairs.github.io/va-mobile-app/design/Intro) for the most organized form of the documentation. The [engineering documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/About/For%20engineers/overview) there also exists in this repo either in the `documentation` folder or as `README`'s tied to particular packages.
8 changes: 4 additions & 4 deletions documentation/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@ Our packages:
- assets
- Package containing static assets (e.g. fonts, SVG icons) for VA mobile apps
- Peer dependency (required) to components for appropriate function
- [Documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/For%20engineers/assets)
- [Documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/About/For%20engineers/assets)
- [NPM](https://www.npmjs.com/package/@department-of-veterans-affairs/mobile-assets)
- [Code](https://github.com/department-of-veterans-affairs/va-mobile-library/tree/main/packages/assets)
- components
- Package containing the components of the design system
- [Documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/For%20engineers/components)
- [Documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/About/For%20engineers/components)
- [NPM](https://www.npmjs.com/package/@department-of-veterans-affairs/mobile-component-library)
- [Code](https://github.com/department-of-veterans-affairs/va-mobile-library/tree/main/packages/components)
- linting
- Package containing an eslint plugin to issue deprecation notices as part of linting
- [Documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/For%20engineers/linting)
- [Documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/About/For%20engineers/linting)
- [NPM](https://www.npmjs.com/package/@department-of-veterans-affairs/eslint-config-mobile)
- [Code](https://github.com/department-of-veterans-affairs/va-mobile-library/tree/main/packages/linting)
- tokens
- Package containing atomic, tokenized building blocks used for components so any app can build screens or custom components adhering to the same underlying styling fundamentals
- [Documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/For%20engineers/tokens)
- [Documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/About/For%20engineers/tokens)
- [NPM](https://www.npmjs.com/package/@department-of-veterans-affairs/mobile-tokens)
- [Code](https://github.com/department-of-veterans-affairs/va-mobile-library/tree/main/packages/tokens)

Expand Down
2 changes: 1 addition & 1 deletion packages/tokens/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Depending on what is being contributed, the recommendation for how to proceed di

If you are contributing a simple addition or update of an existing token, the recommendation is to do so [in the GitHub web interface](https://github.com/department-of-veterans-affairs/va-mobile-library/tree/main/packages/tokens/src/tokens) by updating the relevant src tokens file and [running an alpha publish against the branch for the package](https://github.com/department-of-veterans-affairs/va-mobile-library/actions/workflows/publish.yml) to affirm the `dist/` folder correctly forms up your updated/added token as expected in the [resulting NPM package](https://www.npmjs.com/package/@department-of-veterans-affairs/mobile-tokens?activeTab=versions).

If you are contributing many tokens or need to adjust build processes, you should get set up locally. See the [directions in the components package documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/For%20engineers/components) for doing so with minor modifications to that process of changing directory to the tokens package (`va-mobile-library/packages/tokens`) instead of components and not having the final running steps as the `tokens:build` command is essentially running the tokens as it generates the output folders based on the build/config setup and tokens in the `src/` folder.
If you are contributing many tokens or need to adjust build processes, you should get set up locally. See the [directions in the components package documentation](https://department-of-veterans-affairs.github.io/va-mobile-app/design/About/For%20engineers/components) for doing so with minor modifications to that process of changing directory to the tokens package (`va-mobile-library/packages/tokens`) instead of components and not having the final running steps as the `tokens:build` command is essentially running the tokens as it generates the output folders based on the build/config setup and tokens in the `src/` folder.

Note: the folder structure and file naming within the `src/` folder is relevant so follow the existing structure and direct questions to [the DSVA Slack channel](https://dsva.slack.com/archives/C05HF9ULKJ4).

Expand Down

0 comments on commit a2b02fd

Please sign in to comment.