centrifuge / documentation Goto Github PK

View Code? Open in Web Editor NEW

15.0 14.0 69.0 53.07 MB

Documentation for Centrifuge

Home Page: https://docs.centrifuge.io/

License: GNU Affero General Public License v3.0

JavaScript 97.55% CSS 2.45%

documentation's Introduction

Centrifuge Documentation

About

Centrifuge is an open, decentralized operating system that provides a method to create, exchange, and use the data used in the financial supply chain. It creates transparent and shareable relationships between interacting companies.

This project documents the procedure to set up a Centrifuge Node. For the step-by-step procedure, see Docs.

For information on the Centrifuge code, see our other repos.

To become a part of the Centrifuge community, read the Code of Conduct and join Discord.

Contributing

Please, feel free to make any contributions you think will make Centrifuge Documentation better.

Submit all pull requests to the develop branch

The develop branch is continuously deployed to a preview site. View dev site. You can submit a pull request to the repository to get a deploy preview built.

Development

Dev server

This repo uses yarn v4 to enable building on Cloudflare pages. If this is your first time using yarn v4 follow these steps:

clear all generated folders (.cache, public, node_modules)
install yarn v4: corepack enable and yarn init -2
ensure you're using the correct node version: nvm use. You should be using node v18.19.1
install dependencies: yarn install
start the dev server: yarn develop

Images

Place all the static images under docs/ folder close to the relevant content and add the relative path of the image along with alt tag in the Markdown file like below

![Tinlake UI](../../images/tinlake/tinlake-ui.png)

You can use styling attributes on images

![Tinlake UI](../../images/tinlake/tinlake-ui.png#width=200px;float=right)

For more information and how to add custom attributes, refer to the gatsby-remark-image-attributes plugin.

LaTeX

We're using KaTeX to display Math formulas inside the Markdown like below:

$$
D = P \times (1 + \frac{r}{n})^{nt}
$$

License

Centrifuge Documentation is licensed under the Creative Commons Attribution-ShareAlike 2.0 License

documentation's People

Contributors

Stargazers

Watchers

Forkers

rdinicut mayalouise dininski xmxanuel charleenfei pstehlik vimukthi-git mkaczynski11 lucasvo philomene57 ilinzweilin loganbek developerfred sounak98 acolytec3 agbilotia1998 millnitzluan rbeer cleancoindev dy-dedi jennypollack mario-sangar eiupanther96 matthews3301 asymmetric 0x63757465 ezionew sebastianp74 lynchqu25 mezoantrop lbrian13 hardikpatel1985 almanaka truonglx-56 mikiquantum kicassidy schmittlea yaroslvozl katebee-1 bugraayan1 zaatarherb sankalpk annamehr tjure07 tankofzion rhanok09 roollie denniswell tsunderestorm elpretentio mpontus esthercentrifuge imdior wagmitothemoon vozlomytel ericablomquist cdamian varun24143 omahs atbaum armandomistral sibelly defirasta lakcoder redknight13 jnrlouis bgodlin

documentation's Issues

Fix faq: use yaml

I would like to use the tinlake FAQ feature we had on the website for this going forward. See this for the implementation: https://github.com/centrifuge/website/pull/179/files#diff-ec5978fa5620c8847e98a432f6e95a9602a218b6f5e0f66e75a07663ba6b8bbfR1

This addresses my comment in #236

FEE: Missed information in new version

Hi
I noticed that after changing the fee for swapping CFG to wCFG the information about the fee applicable just disappear.

I think that this is an issue because the user should be notified about the fee applicable before swapping.

Would be great to update our documentation and implement (return back) notification before the swap.
Thank you in advance.

Add robots.txt

We should add a robots.txt file to allow indexing

transactions endpoint are deprecated but still in docs

with the latest release, transactions are now called jobs

https://centrifuge-os-node-api-1.api-docs.io/0.0.3-alpha4/transactions/8pZTEvT5XWYsMuGWa

this reference to an API point that does not exist, it should instead be /jobs/{job_id}

404 on page-data.json

We have a very high rate of 404s on page-data.json. We should fix this with the fix discussed in this issue: gatsbyjs/gatsby#16097

Resource not found	Requests
/page-data/learn/page-data.json	16,512
/page-data/use/page-data.json	15,973
/page-data/build/page-data.json	15,294

Weighting for epoch documentation is wrong

In https://docs.centrifuge.io/learn/epoch/#the-solver-mechanism, under the solver optimization, "Sample weights to ensure a waterfall-like priority focused on DROP seniority could e.g.

DROP redemptions: 100,000,000,000 [Ensure seniority]
TIN investments: 100,000,000 [Build up risk buffer]
DROP investments: 100,000
TIN redemptions: 100 [Ensure Min TIN risk buffer stability]" should be "Sample weights to ensure a waterfall-like priority focused on DROP seniority could e.g.

DROP redemptions: 1,000,000 [Ensure seniority]
TIN redemptions: 100,000 [Ensure TIN investors can redeem]
TIN investments: 10,000 [Build up risk buffer]
DROP investments: 1,000

Footer: move to axis

We should move the footer component into axis and unify its usage across the two repos/user interfaces:

http://centrifuge.io // github.com/centrifuge/website
http://developer.centrifuge.io // (this repo)

The footer should be configurable:

Stretch: make its content the full width like it is now on developer.centrifuge.io or a the same widht as the content (as on centrifuge.io)
We should be able to define custom columns and layouts to implement the two different versions that we have today.

Acceptance Criteria:

Add PR for generic component to axis
Update website and developer docs to make use of new component

This issue has a gitcoin bounty attached to it. We encourage bounty hunters to join our slack and talk to us. We also encourage you to tackle more than one of our open bounties! If you'd like to start working on it, feel free to reach out to me ([email protected]) directly, join our slack channel #bounties on our slack

Spacing between contributor and title is too small.

The "y" should not be that close to the emojis.

Left Sidebar Navigation

We currently have two levels of navigation. The top lists different sections, e.g. Chain, Node, Tinlake. When you then navigate to a section we show the the subsections on the left.

We want to change the navigation on the left to show the top level components as well similar to what wiki.polkadot.network does with collapsing headers for each section of the documentation.

When searching old results appear

Search seems to be cached and when searching old results appear.
Ex:when typing webhooks the search returns https://developer.centrifuge.io/docs/getting-started/install-cent-node#additional-custom-configuration which does not exist anymore

We need to login in agnolia and reset the cache

Add Description for Operator and Assesor/Interest & Ratio

https://github.com/centrifuge/developer.centrifuge.io/blob/develop/docs/tinlake/contracts/contracts.md

Search: Render Icon instead of Search Input

See design in #146

Image Improvements

We want to improve how images are handled in markdown files. There are three issues currently we should clean up in one go:

Our content images are currently in src/... this mixes them with the javascript source used to build the docs instead of putting them with the content in docs/... We should move them over to the docs folder into the subfolders along with the pages. The image component should be able to render images from docs/ properly when building the site.
We'd like to be able to resize images dynamically. We need to modify our md component parser and make it parse the URL of the image to support defining width/height as well as float in the rendered html based on the attributes defined in the image URL

![Tinlake UI](./tinlake-ui.png width=100&float=right)

Images that have a lot of detail should be clickable to enlarge. Clicking an image that has a "zoom=true" attribute defined should render a "lightbox" in front of the content showing the diagram at 100% of the window. This should also be controlled with a custom in the image option. An example lightbox can be found here: https://www.gatsbyjs.org/blog/2018-11-03-building-an-accessible-lightbox/ though feel free to use a different one.

![Tinlake Call Graph](./callgraph.svg float=right&width=500&zoom=true)

Acceptance Criteria for this bounty:

Move content all images from the src/ folder to the respective doc folder
Show how an image would look resized using parameters in the URL
Add a lighbox to the svg diagrams on https://developer.centrifuge.io/tinlake/
Document the custom syntax options added here in the repo README0.001

Improve Google PageSpeed Insights

Score: 53 https://docs.centrifuge.io/

https://developers.google.com/speed/pagespeed/insights/?hl=en&url=https%3A%2F%2Fdocs.centrifuge.io%2F

A low score doesn't permit have a better impact on google search.

Due to low results, the search bot reduces the ranking in the search query, which negatively affects the promotion of the project and users who are looking for the necessary information/documentation cannot find it through official channel

Correct alignment and add contacts

Correct alignment and add contacts to official channels: discord, TG, Github and ecc.

Outdated screenshots in Set Up CFG Wallet

Polkadot.js screenshots need to be updated for https://docs.centrifuge.io/use/setup-wallet/

/getting-started/install-cent-node/

update createconfig information for new go-centrifuge node version

also review general state of docs for accuracy

Bridge

This is a bridge CFG/WFG? docs/build/bridge/index.md

Images should not be streched when resized

Contributors: fetch contributors from github change history

We can get contributors for a given file by querying the git log and should display users and emails instead of manually adding contributors to the .md file.

Move code of conduct into footer and out of cent-node docs

The page https://developer.centrifuge.io/cent-node/further-reading/contributing/ should be moved out of the cent-node section. Instead we should add a link to the footer pointing to the code of conduct page outside of any particular section.

Acceptance Criteria:

The markdown file should be moved to docs/code-of-conduct.md
A link should point to it in the footer

Shifted menu in mobile device

Hello
The left menu shifted outside and can not be accessible from a mobile device.

The resolution of the display doesn't matter. The issue with menu exist always.

Record a screencast of a node setup

Add webhooks documentation

how to set-up
what are the expected payloads
how to test they are set-up properly (possibly trigger them with dummy/test values from the centrifuge node?)

Support LaTex formulas embedded in markdown using mathjax

We'd like to be able to embed formulas into our markdown docs using MathJax similarly to how HackMD is doing it (e.g. https://hackmd.io/features#MathJax).

The following is an example of how formulas can be embedded in Markdown:

The *Gamma function* satisfying $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ is via the Euler integral

$$
x = {-b \pm \sqrt{b^2-4ac} \over 2a}.
$$

$$
\Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
$$

Acceptance Criteria:

Adding any LaTex Math Formula to the markdown content should render the formula properly on the site when built with gatsby. Use the above example for testing.
If any libraries that we rely on have to be modified, please submit separate pull requests to the upstream projects and do your best to ge them merged.

This issue has a gitcoin bounty attached to it. If you'd like to start working on it, feel free to reach out to me ([email protected]) directly, join our slack channel #bounties on our slack

Mistake in calculating NAV sample.

Hi Centrifuge friends:
I found 2 mistakes in the doc.

in this page: https://github.com/centrifuge/documentation/blob/develop/docs/learn/pool-valuation/index.md
in the example, one year is considered 360 days (31104000 seconds), but in the formula do the calculation, it actually used 31536000 seconds (365 days).
in this page: https://docs.centrifuge.io/learn/interest-rate-methodology/
according to the calculation, the basic fomular is wrong, it should be D = P (1+rate)^n

Please help check it, thanks.

Better image handling in developer docs

We would like to support the addition of screenshots to the documentation. Currently, there are images directly embedded from urls, these should be available statically and displayed as grommet image components and allow them to assign image sizes.

An example of what images look like now: https://deploy-preview-142--staging-centrifuge-documentation.netlify.com/tinlake/tinlake-demo/user-flow/

We should have a way to format images in markdown using some non-standard syntax. Features to support:

Size: full-width or specific size
Alignment: center full screen or inline with text left or right

Page not found for two links on build section

https://github.com/centrifuge/documentation/blob/develop/docs/build/cent-chain/index.md

The sections:

Kusama Documentation
Polkadot Wiki (also covering Substrate relevant features)

The addresses used for this pages are not found anymore.

Broken link

found broken links in DOC:
Read more about the bridge design in the ChainBridge Specification. The Centrifuge<>Ethereum bridge currently supports Substrate Native <> ERC20 token transfers.

Link broken

Regarding the Operating Agreement of the SPVs.
This one: broken

Broken link on legal documentation page

In https://docs.centrifuge.io/learn/legal-offering/, under the 4th point of Asset Finance Flow, the link to Operating Agreement is broken. It should go to https://docs.google.com/document/d/1KutVN5otIXHFFcEZnvJ3s65u3ns9axmM/edit

Update docs to use gatsby and a new theme

Rebuild the developer documentation to use gatsby under the hood with Grommet in the frontend, see attached screenshot.

Mobile Navigation on documentation should use the same code/design as nav on centrifuge.io

The mobile navigation on developer.centrifuge.io and centrifuge.io should look the same. It should cover the entire screen width instead of just the right part and have the same text spacing for the nav items. We have a styled ui components library at github.com/centrifuge/axis. Both the docs and the website should use a component from axis for the library.

Acceptance Criteria:

Modified the developer.centrifuge.io and website repo to both use a navbar component import from axis

Search bar not working

I think we may need to switch from algolia... any ideas?

Documentation Landing Page Design Update

we need to add a section to the documentation for all chain related topics. The final design and content for the home page is listed in the comments below:

Acceptance Criteria

Change the copy of the homapage to the text specified below
Change the design to reflect the mockup attached in the comments below.
Sizing: on a 13" screen (roughly 900px in height) two rows of icons should be visible.

Question about the Centrifuge chain

I have some question,please help me solve these,I would appreciate it !

First Question: Can you give me a public blockchain node?

Second Question: 
    What is the thransfer crowdloanclaim-claim_reward meaning ?
    What is the thransfer parachainsystem-set_validation_data meaning ?

Third Question: If we have the api or others rpc to connect with the centrifuge chain?

Fourth Question: if you can provide others document about the centrifuge chain,in addition to "https://docs.centrifuge.io/build/cent-chain/#introduction", It can make me know more about the characteristics of this chain；

404s on page

The following pages have a high number of 404s - we should add correct redirects, set a favicon and make sure we don't link to the apple-touch icon or add something there.

Resource not found	Requests
/zabbix.php	1,000
/favicon.ico	485
/apple-touch-icon.png	106
/tinlake/overview/tranches/	103
/tinlake/overview/introduction/	100
/2b00d5f13e1d83ef674fdc23bf4965929c43cf43-e93c7a0a16c8609bc6be.js	88
/page-data/tinlake/overview/introduction/page-data.json	84
/tinlake/overview/introduction	82
/apple-touch-icon-precomposed.png	81
/wp-login.php	67
/docs/overview/protocol-architecture/	62

Improve navigation and structure of Documentation page

Background/Issue:

How it currently works:
We basically have 3 Layers at the moment
Parts - Getting started, learn, Use Make… (L1)
Sections - First level of the parts (L2), this is also where already the page/content is
Subsections - These are already the subsections of each content/page which are a also displayed in the navigation panel (L3)

Probelm:
Only having 3 Layers and being forced to having all content already on L2 really narrows how we structure and grow the documentation. We can mainly grow horizontally (splitting into more parts) and not vertically (going deeper into the Layers)

ACs
My ideal approach would be to have a infrastructure of 4 Layers (e.g. Parts, Segments, Sections, Subsections) where all 4 Layers are still displayed and navigated in the navigation bar, but where it is also possible to have content on L3 or L4. E.g. some parts perhaps don’t require 4 Layers others do. Then the Navigation pane most be smart enough to display this correctly.

Minting an NFT Docs

There are a bunch of bullet points included in this as a JPG photo, this should be regular markdown content: https://docs.centrifuge.io/learn/p2p-protocol/#minting-an-nft

FAQ: Add section about faucet

Add a section documenting the rinkeby faucet

Review https://developer.centrifuge.io Documentation Update

Overview of structure and content can be found here:
https://hackmd.io/ibuQTAV0StqfZRa6utlQ2A?both.
This documents also links to all the current drafts for the sections in hackmd

Change Tinlake link from DevDoc landing page

When you click on Tinlake from the DevDoc landing page, the link leads you to https://developer.centrifuge.io/tinlake/overview/ui/, however it should lead you to https://developer.centrifuge.io/tinlake/overview/introduction/

Similarly, if you try to reach https://developer.centrifuge.io/tinlake it leads you to https://developer.centrifuge.io/tinlake/overview/contracts/

Add a note about accounts needing gas to documentation

Don't show "Prev" arrow if there isn't any previous page

On the get started page the previous button is shown but doesn't do anything. Let's hide it.

https://60940b0c80ded4000795785e--documentation-staging.netlify.app/learn/getting-started/

In-page navigation in right column scrolls to correct place but does not set anchor

When navigating through a long article using the right column navigation, clicking on the sections scrolls through the page but does not update the URL to a permanent link to the section. E.g.:

On the page /tinlake/overview/introduction/ clicking on the section "Loan Lifecycle" should update the URL to: http://localhost:8000/tinlake/overview/introduction/#loan-lifecycle. The href="" attribute of the link is set correctly but somehow the URL doesn't get updated.