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.

Sign up for GitHub

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

Jump to bottom

docs: structure and content update #2875

Merged
merged 93 commits into from
Sep 11, 2024
Merged

docs: structure and content update #2875

merged 93 commits into from
Sep 11, 2024

Conversation

JoblersTune
Copy link
Collaborator

@JoblersTune JoblersTune commented Aug 20, 2024 •
edited
Loading

Changes proposed in this pull request

  • Do not merge -> still a collaborative work in progress
  • Restructuring the docs and adding in updated content

Context

Checklist

  • Related issues linked using fixes #number
  • Tests added/updated
  • Documentation added
  • Make sure that all checks pass
  • Bruno collection updated

@github-actions github-actions bot added pkg: documentation Changes in the documentation package. type: documentation (archived) Improvements or additions to documentation labels Aug 20, 2024
@netlify Netlify
Copy link

netlify bot commented Aug 20, 2024 •
edited
Loading

✅ Deploy Preview for brilliant-pasca-3e80ec ready!

Name Link
🔨 Latest commit 06d0a53
🔍 Latest deploy log https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/66e0b8d1dae6220008cee870
😎 Deploy Preview https://deploy-preview-2875--brilliant-pasca-3e80ec.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@JoblersTune JoblersTune added the do not merge Do not merge PRs with these label label Aug 20, 2024
JoblersTune and others added 15 commits August 21, 2024 22:04
@JoblersTune @huijing
Updated docs structure
b62ff73
@JoblersTune @huijing
chore: removing all docs copy, ready for new contant
4a1e036
@melissahenderson @huijing
testing collab on sarah's branch (#2869)
d92ab32 
* testing collab on sarah's branch

* docs: trying again
@hajjimo @huijing
docs: integrator-checklist-update
6150300
@brad-dow @huijing
docs: testing update (#2870)
7cb832a 
Adding text to overview
@JoblersTune @huijing
chore: formatting
1fdc4dd
@JoblersTune @huijing
chore: formatting
01b319b
@JoblersTune @huijing
chore: fixed .prettierignore file
7f6fbf9
@hajjimo @JoblersTune @huijing
docs: Add submenus to Integration section (#2871)
a64b0ac 
* docs:  Add submenus to Integration section

---------

Co-authored-by: Sarah Jones <[email protected]>
@JoblersTune @huijing
chore: updating .gitignore
f500411
@melissahenderson @huijing
docs: upload of doc set to prep for Rafiki ww
3c2e5eb
@melissahenderson @huijing
docs: fixing linkout issue
1300737
@melissahenderson @huijing
docs: another linkout fix
90f4137
@melissahenderson @huijing
docs: sigh
7017633
@huijing
resolve conflicts and attempt to remove generated files
c31c3ce
@huijing huijing force-pushed the sj/docs-structure-update branch from 86eaf46 to c31c3ce Compare August 21, 2024 14:16
huijing and others added 10 commits August 21, 2024 22:16
@huijing
remove generated files from source
f3c643d
@huijing
git ignore generated files
c475a26
@brad-dow
docs: Imported first batch of Rafiki
9e8ce60 
- Intro > Overview
- Intro > ASE
- Integration > Getting Started
- Integration > Exchange Rates
- Integration > IDP
- Ran prettier to avoid the docs-pocalypse
@hajjimo
docs: test-update
218ac44
@hajjimo
docs: mi-test-pr
5629901
@brad-dow
docs - second round of Rafiki imports into new project
b414ec6 
Added the following pages:
- Integration > Adding asset
- Integration > Adding peer
- Integration > Creating wallet addresses
- Components > Accounts, transfers, and liquidity
- Resources > Glossary
- Resources > Admin UI Guide
@hajjimo
docs: mi/docs-update-batch1
853e1fb
@hajjimo
docs: mi-docs-update
c393b66
@hajjimo
docs: mi-docs-update
2591fd9
@hajjimo
docs: mi/docs-update
5b2a27c
@brad-dow
docs: updating Rafiki Admin guide
e6be98c 
- Adding contextual information around obtaining login credentials
- Adding information around deactivating a wallet address through the UI
JoblersTune
JoblersTune commented Sep 10, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@JoblersTune
Copy link
Collaborator Author

The Rafiki Admin auth docs still need to be included. Currently we have a page packages/documentation/src/content/docs/rafikiadmin/auth.md which is not used. This content needs to be added in the correct location and the packages/documentation/src/content/docs/rafikiadmin folder must then be deleted as well.

@github-actions github-actions bot added pkg: backend Changes in the backend package. type: source Changes business logic labels Sep 10, 2024
@brad-dow
docs: update Rafiki Admin guide
7ff9b68 
- Incorporate Rafiki Admin auth information in the guide
@brad-dow
docs: folder cleanup
d1db96d 
- Removed auth.md
- Removed rafikiadmin folder
@brad-dow
Copy link
Contributor

The Rafiki Admin auth docs still need to be included. Currently we have a page packages/documentation/src/content/docs/rafikiadmin/auth.md which is not used. This content needs to be added in the correct location and the packages/documentation/src/content/docs/rafikiadmin folder must then be deleted as well.

I've removed auth.md as well as the rafikiadmin folder. All of the contents of the deleted auth page are now located in the Rafiki Admin guide.

@JoblersTune JoblersTune merged commit 0b92ce3 into main Sep 11, 2024
30 of 42 checks passed
@JoblersTune JoblersTune deleted the sj/docs-structure-update branch September 11, 2024 13:11
@melissahenderson melissahenderson mentioned this pull request Sep 11, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hajjimo hajjimo hajjimo left review comments

@sabineschaller sabineschaller sabineschaller left review comments

@mkurapov mkurapov mkurapov left review comments

@melissahenderson melissahenderson melissahenderson approved these changes

Assignees
No one assigned
Labels
do not merge Do not merge PRs with these label pkg: backend Changes in the backend package. pkg: documentation Changes in the documentation package. pkg: frontend Changes in the frontend package. pkg: mock-ase type: documentation (archived) Improvements or additions to documentation type: localenv Local playground type: source Changes business logic
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@JoblersTune @melissahenderson @brad-dow @mkurapov @sabineschaller @hajjimo @huijing