nunetwork / documentation Goto Github PK

Stumbled upon this while creating a document. Make of it what you will.

<h3 id="nubits-official-wallet-nu">NuBits Official Wallet (Nu)</h3>

— https://docs.nubits.com/

Use a name. Using an ID isn't necessary in HTML 5 and will create global variables in your JavaScript

Many libraries (i.e., not your own JS, but someone else's) use a single global - for example, fineuploader. If you make an element with an ID of fineuploader, you will be unable to use the fineuploader module. Avoiding creating unnecessary globals helps avoid those conflicts.

— https://stackoverflow.com/questions/5319754/cross-reference-named-anchor-in-markdown/17028463#17028463

Page Title: NuBits Discourse Assistant Bot
URL: https://docs.nubits.com//nubits-discourse-bot/

Update Suggested

Here are some edits that I think need to be made on this page...

"The NuBits Discourse Assistant Bot it is designed to be used on the NuBits official forum to retrieve..."

• Add the word "the" at the beginning and middle of the sentence. Placements are bolded in the quote above.
• Remove the word "it."

"As well as helping in the formatting of motions , the bot can also fetch..."

• Remove the extra space between the word "motions" and the comma.

"Things like the current liquidity, the current difficulty, the current state of a particular motion or the current park rates can all be accessed with a simple command.
Because the bot is hooked into the Nu Network, it can also let any user tip NuBits to any other user on this forum."

• These two sentences are the ending and beginning of two separate paragraphs, but they're too close together. There needs to be a line break in between.

"To get started with tipping, send a PM with the word ‘register’ to assistant . If you send someone who hasn’t registered a tip, I’ll create them an account and let them know a tip is waiting for them."

• This part of the paragraph sounds as if it was lifted from the forum without editing the language. The word "I'll" sounds like it's referring to the assistant bot, but it doesn't fit with the rest of the paragraph. I think the paragraph needs some altering to make more sense.

Page Title: NuWebService
URL: https://docs.nubits.com//nuwebservice/

Update Suggested

The following sentence needs editing...

"This information is essential for people that wants to buy and park nubuts."

• Remove s from wants
• Change nubuts to NuBits

Also this sentence needs a closer look...

"An overview on over parked NuBits"

Is the inclusion of the word "over" a mistake?

As @desrever-nu pointed out, this page needs to be updated:

"https://docs.nubits.com/using-a-data-feed/ this page may need an update (fees addess) , if someone has a minute for it"

Page Title: NuBot Parametric Orderbook
URL: https://docs.nubits.com//parametric-orderbook/

Update Suggested

"Up untill NuBot v0.3.1, all the available liquidity was put up on..."

• Remove extra "l" in the word "until."

"controlled by bot operators : the parametric order book. "

• Remove space between operators and the colon.

"If you launch NuBot with the GUI, you will be able to change parameters and see a real time preview of how changing parameters affects the sahpe of your orderbook."

• "shape" is spelled wrong.

Would it make sense to add Desrever's thread about parametric order books as the 4th link for community discussions in the first paragraph?

https://discuss.nubits.com/t/modelling-a-parametric-order-book/1082

Page Title: Liquidity Pools
URL: https://docs.nubits.com//liquidity-pools/

Update Suggested

"The first example of a managed liquity pool was created by Henry "

• Liquidity is spelled wrong

"In the same way that anyone can contribute hashing power to help maintain the bitcoin network"

• I think Bitcoin needs to be capitalized.

"The design of the automated pool is intended to significantly reduce the counter-party risk involved to pool contributers by keeping funds in their control."

• Contributors is spelled wrong.

Page Title: Minting on a Raspberry Pi
URL: https://docs.nubits.com//nu-raspberry-minting/

Update Suggested

Installing BerkeleyDB4.8 from source - in case no repository with compiled packages can be found

don't install libdb++-dev from repository - it might be newer than 4.8 and nud compiled with libdb > 4.8 converts .dat files in ~/.nu to a format that is not compatible with official releases that use libdb4.8

Adjusted dependencies for compiling nud with libdb4.8:

sudo apt-get install checkinstall subversion git git-core build-essential libssl-dev libboost-dev libboost-system-dev libboost-filesystem-dev libboost-program-options-dev libboost-thread-dev libcurl4-openssl-dev libminiupnpc-dev

cd ~/
wget http://download.oracle.com/berkeley-db/db-4.8.30.tar.gz
tar xvf db-4.8.30.tar.gz
cd ~/db-4.8.30/build_unix
../dist/configure --enable-cxx
make

this might take a while - even on RaPi2

sudo make install
export BDB_INCLUDE_PATH="/usr/local/BerkeleyDB.4.8/include"
export BDB_LIB_PATH="/usr/local/BerkeleyDB.4.8/lib"
sudo ln -s /usr/local/BerkeleyDB.4.8/lib/libdb-4.8.so /usr/lib/libdb-4.8.so
sudo ln -s /usr/local/BerkeleyDB.4.8/lib/libdb_cxx-4.8.so /usr/lib/libdb_cxx-4.8.so

Should include

• using {% highlight (type) %} {% endhighlight %} for code highlights instead of standard markdown for code highlights
• How to create callouts on pages, and the different kinds of callouts

Anything else?

Page Title: Performing Backups
URL: https://docs.nubits.com//performing-backups/

Update Suggested

Add in a section about how to import a backup (i.e. go to the data directory and all that). Alternatively, we should add an 'import' feature to the client.

Page Title: Hosting a Data Feed
URL: https://docs.nubits.com//hosting-a-data-feed/

Update Suggested

Add section explaining how to create URL signature.

Page Title: NuDroid Specifications
URL: https://docs.nubits.com//nudroid/

Update Suggested

Release notes NuDroid v4.0:

The ability to add more than one trusted server to the App to allow users to set up their own trusted server besides the default server
Allow prioritisation and fall-back to these trusted servers to increase resiliency of the App.

Inline code needs to be confirmed.

Page Title: RPC API
URL: https://docs.nubits.com//rpc-api/

Update Suggested

Remember to preface all commands with wither -unit=B for NBT or -unit=S for NSR.
Example: nud -unit=B listaccounts

Page Title: Hosting A Data Feed
URL: http://nunetwork.github.io/hosting-a-data-feed/

Update Suggested

Test of the new "Suggest An Update" content link with auto-populating issue report.