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

The documentation links on the repos need updating #337

Closed
willmcvay opened this issue Feb 16, 2020 · 1 comment · Fixed by #340
Closed

The documentation links on the repos need updating #337

willmcvay opened this issue Feb 16, 2020 · 1 comment · Fixed by #340
Assignees
Labels
chore Maintenance or housekeeping tasks foundations Issues relating to Foundations front-end Relates to front end issues

Comments

@willmcvay
Copy link
Contributor

  • On the Readme.md of each package there is a link that is broken to our documentation and the text: For detailed documentation visit here. The links wrapping the word here all need to point to: https://foundations-documentation.reapit.cloud/open-source
  • Before the the line For detailed documentation visit here. each package should have a brief description of the repo. These descriptions are already on the docs see: https://foundations-documentation.reapit.cloud/open-source/packages for example for Marketplace "The core frontend of the Reapit Foundations platform. Contains all functionality in both the Marketplace and Developer Portal applications." Copy and paste this before the "For detailed documentation..." line for each package.
  • On the main README.md at the root, the link in the line "Detailed documentation on all aspects of the platform is available at this external link." needs to be updated to: https://foundations-documentation.reapit.cloud/open-source
@willmcvay willmcvay added chore Maintenance or housekeeping tasks foundations Issues relating to Foundations front-end Relates to front end issues labels Feb 16, 2020
@duong-se duong-se self-assigned this Feb 17, 2020
@duong-se
Copy link
Contributor

duong-se commented Feb 17, 2020

Hi @willmcvay, in packages the production and development link of aml-checklist, geo-diary and lifetime-legal seems to be swapped, can you verify it please?

The marketplace is right though

Also, shouldn't the readme of individual package be pointing to their anchor tag? e.g Marketplace would be https://foundations-documentation.reapit.cloud/open-source/packages#marketplace

duong-se added a commit that referenced this issue Feb 17, 2020
* chore(readme): #337 update readme of packages

* chore: bump version for react-app-scaffolder
nphivu414 pushed a commit that referenced this issue Apr 29, 2020
* chore(readme): #337 update readme of packages

* chore: bump version for react-app-scaffolder
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Maintenance or housekeeping tasks foundations Issues relating to Foundations front-end Relates to front end issues
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants