search

department-of-veterans-affairs / va-mobile-app

"If VA were a company, it would have a flagship mobile app."
https://department-of-veterans-affairs.github.io/va-mobile-app/
12 stars 2 forks source link

[Documentation] Internationalization #2637

Closed narin closed 2 years ago

narin commented 2 years ago

Description

As an engineer I want to create Internationalization documentation for our site, so that we can have all of our documentation organized in a single place.

Imagine you were brand new to the project. What information do you wish you had on this topic when you started?

Acceptance Criteria

- [ ] Create a new .md file that lives under Engineering -> Front End, on a new page titled Internationalization - [ ] This documentation should include but not be limited to: - [ ] How do we organize our language/copy? - [ ] Namespacing - [ ] How do we display copy in our app? (i.e. useTranslation() and t()) - [ ] What features does the t() function have? - [ ] Code snippets of .json files, invoking `useTranslation()`, `t()` function usage - [ ] This content should be suitable for someone who is brand new to the project. Revise/update as necessary. - [ ] Include screenshots and code snippets where appropriate ## Notes & Open Questions - Dependencies/Roadblocks: - Any internal/external dependencies? No - Test accounts needed? No - Does this require QA? Yes. QA should verify that the new documentation page exists once it is deployed - Dev Notes: - Our documentation lives in the same codebase as our mobile app in the `VAMobile/documentation` folder - To run the documentation site locally, cd into the above folder and then run `yarn && yarn start` - You do not need to worry about deploying. Deployment of the docs site is automated and occurs nightly
narin commented 2 years ago

Confirmed content is available on our documentation site. Closing out.