Commit Graph

742 Commits (02bb2e2f7652c14f0abf2283a81e6303df6408fc)

Author SHA1 Message Date
derekpierre bcaa4c2bd6 Flesh out initial API documentation for Porter endpoints. 2021-07-26 15:14:43 -04:00
derekpierre 9c7051ce6a Very rough initial diagram and blurb for Porter documentation. 2021-07-26 15:14:43 -04:00
Kieran Prasch e4594739a1 Update documentation to use Keystore and deprecate Keyring. 2021-06-28 14:33:31 -07:00
Kieran R. Prasch f0080b3e2e Minimally restore attachment of keystore 2021-06-28 14:33:31 -07:00
Kieran Prasch a0926112ad
Bump version: 5.2.0 → 5.3.0 2021-06-17 13:13:48 -07:00
Kosta 8fec1ce799 Update suggested pytest command to target unit tests 2021-05-20 16:24:26 -04:00
KPrasch e5c04859f9
Merge pull request #2694 from nucypher/fix-typo
Fix typo
2021-05-18 23:11:43 -07:00
David Núñez 4d873c6442 Apply suggestions from code review
Co-authored-by: Derek Pierre <derek.pierre@gmail.com>
2021-05-17 10:20:51 +02:00
David Núñez e87738c0f0 Fix math subindices 2021-05-17 10:20:51 +02:00
David Núñez 459d4ce0d4 Fix bad RST format for caution note and external ref 2021-05-17 10:20:51 +02:00
David Núñez 030b65b97f First pass at rewards documentation 2021-05-17 10:20:51 +02:00
David Núñez 668b0a401c Add boosts to example tables in CLI docs 2021-05-17 10:20:50 +02:00
piotr-roslaniec 572242faf4
Fix typo 2021-05-13 09:25:47 +02:00
KPrasch ae07242db6
Merge pull request #2665 from KPrasch/docs
Detailed description of Ursula's web status page
2021-05-07 14:27:50 -07:00
KPrasch 11cd9e5d3f
Update docs/source/staking/running_a_worker.rst 2021-05-07 14:27:34 -07:00
KPrasch af8b56a7db
Apply suggestions from code review
Co-authored-by: Derek Pierre <derek.pierre@gmail.com>
2021-05-07 14:18:38 -07:00
derekpierre b412d17340 Update service pricing fees to reflect 7-day period duration. 2021-05-03 10:08:27 -04:00
David Núñez 4466ea068d
Merge pull request #2634 from piotr-roslaniec/rewards-cmd#2509
Improve Rewards command
2021-04-28 22:03:44 +02:00
Piotr Roslaniec 7e57119767 Apply PR suggestions 2021-04-27 16:10:38 +02:00
Kieran Prasch 07cab383d2 Detailed description of the ursula web status page 2021-04-26 12:12:06 -07:00
Kieran Prasch e2d60412c6 Adjustments to worker setup documentation and docker command reccomendation. 2021-04-26 12:11:59 -07:00
Kieran Prasch 8668a49dab
Bump version: 5.1.0 → 5.2.0 2021-04-26 10:19:19 -07:00
Piotr Roslaniec eee2264ca1 Rename flags 2021-04-23 15:53:51 +02:00
Piotr Roslaniec 45fb78f5f4 Update docs 2021-04-23 15:42:39 +02:00
Piotr Roslaniec bcc4dc0902 Fix malformed table 2021-04-22 17:04:40 +02:00
Piotr Roslaniec 558ba24413 Update docs 2021-04-22 16:34:58 +02:00
Kieran Prasch 6975c15b95
Bump version: 5.0.2 → 5.1.0 2021-04-15 11:03:33 -07:00
derekpierre 229888ae99 Respond to RFCs for #2617.
Co-authored-by: Bogdan Opanchuk <bogdan@opanchuk.net>
2021-04-15 08:24:41 -04:00
derekpierre 4b1a7fd07c Respond to RFCs in #2617.
Co-authored-by: K Prasch <kieranprasch@gmail.com>
2021-04-15 08:24:41 -04:00
derekpierre 946552f326 Clarify that `--max-gas-price` is optional when initializing a worker. 2021-04-15 08:24:41 -04:00
derekpierre a89e1deb4b Add hint about `--config-file` to output of new configuration init for non-default configuration filepath.
Add docs note about non-default worker configuration files and the use of `--config-file <FILEPATH>`.
2021-04-15 08:24:41 -04:00
Kieran Prasch 555f7c631c
Bump version: 5.0.1 → 5.0.2 2021-04-14 18:53:54 -07:00
Kieran Prasch dd87a7a55c
Bump version: 5.0.0 → 5.0.1 2021-04-14 14:34:57 -07:00
Kieran Prasch 00bb3c7e82
Bump version: 4.8.2 → 5.0.0 2021-04-14 10:04:50 -07:00
KPrasch 74c986e53b
Merge branch 'main' into dao-proposal-1 2021-04-14 08:16:40 -07:00
derekpierre 71d5351501 Add date of switch to 7-day period. 2021-04-14 10:49:00 -04:00
derekpierre 0ac9c0c79d Respond to RFCs for #2610.
Co-authored-by: K Prasch <kieranprasch@gmail.com>
2021-04-09 19:18:35 -04:00
derekpierre 785cc585a2 Add link to MixBytes audit. 2021-04-08 12:27:42 -04:00
derekpierre e4535781e1 Respond to RFCs in #2597. 2021-04-07 10:42:41 -04:00
derekpierre 07f8e7f5c5 Respond to RFCs for #2597.
Co-Authored-By: cygnusv <david@nucypher.com>
2021-04-07 10:42:41 -04:00
derekpierre 7ba20778c5 Clarification of contract lifecycle, disclaimer about risks. 2021-04-07 10:42:41 -04:00
derekpierre 837222c8b0 Add lifecycle section for pooling contract docs. 2021-04-07 10:42:41 -04:00
derekpierre fd099d8946 Initial docs for staking contract work. 2021-04-07 10:42:41 -04:00
vzotova 9194e9ee6e Docs for pool contract 2021-04-07 10:42:41 -04:00
derekpierre f892d0a9af Add updated information about period duration and the consequence of the period duration extension. 2021-04-01 10:21:16 -04:00
derekpierre df28d9c9eb Ensured the use of "daily" in the docs was not used as a reference to period length since the length has now changed. 2021-04-01 10:21:16 -04:00
derekpierre d34187c83b Add updated CLI output to docs for `nucypher stake` command. 2021-04-01 10:21:16 -04:00
derekpierre 36238712a8 Modify events output, the output from block 0 doesn't change, since event already emitted with old values. 2021-04-01 10:21:16 -04:00
derekpierre 039f457376 Very rough draft of period migration page in docs. 2021-04-01 10:21:16 -04:00
derekpierre 2da8be9d10 Respond to RFCs for #2610.
Co-authored-by: Arjun Hassard <arjunhassard@gmail.com>
2021-04-01 10:21:16 -04:00
derekpierre 011da5dcc2 Modifications to sample CLI output. 2021-04-01 10:21:16 -04:00
derekpierre 4782bcd860 Initial modification of docs to reflect updated 7 day period length. 2021-04-01 10:21:16 -04:00
Kieran Prasch 2d05bb5b7d
Bump version: 4.8.1 → 4.8.2 2021-03-25 15:11:39 -07:00
Kieran Prasch 2a896e9add
Bump version: 4.8.0 → 4.8.1 2021-03-24 15:48:18 -07:00
Kieran Prasch e64d4035c8
Bump version: 4.7.1 → 4.8.0 2021-03-23 20:24:23 -07:00
Derek Pierre 1896088f0d
Respond to RFCs for #2599
Co-authored-by: David Núñez <david@nucypher.com>
2021-03-18 09:03:48 -04:00
derekpierre 418fc1f6cd Add documentation about approval / validation requirements for dao voting proposal.. 2021-03-17 16:50:10 -04:00
Kieran Prasch e3dedebc56 Respond to RFCs in PR #2583 2021-03-17 12:21:34 -07:00
Kieran Prasch 84240b4f07 remove_unused -> remove_inactive 2021-03-05 09:56:23 -08:00
Kieran Prasch a5090f69a9
Bump version: 4.7.0 → 4.7.1 2021-03-02 13:19:15 -08:00
Kieran Prasch a580a46280
Bump version: 4.6.0 → 4.7.0 2021-03-02 11:07:35 -08:00
Kieran Prasch 06d89fef07 ContractAdministrator is a BaseActor subclass. Respond to RFCs in PR #2572 2021-03-02 10:24:41 -08:00
derekpierre 3f49a08453 Respond to RFCs for #2573.
Co-authored-by: K Prasch <kieranprasch@gmail.com>
2021-02-26 13:07:26 -05:00
derekpierre 3ad3e2edc2 Add documentation about modifications to 'nucypher status events'.
Minor refactor.
2021-02-26 13:07:26 -05:00
Kieran Prasch c1eed47459 Lynx-based Finnegans's wake demo documentation mentions. 2021-02-13 18:35:31 -08:00
derekpierre f6bfaaee66 Document use of `nucypher stake events` including csv options; document StakingEcrow events. 2021-02-09 11:01:08 -05:00
Kieran Prasch 993fe301cc Use the same ethereum address in alice code snippets. 2021-02-07 14:10:27 -08:00
Kieran Prasch d43ea6ee47 Provide default seed urls in code samples. 2021-02-07 13:29:02 -08:00
Kieran Prasch 1232e9856f More comprehensive granting example script for the docs; Include policy rate. 2021-02-07 12:45:45 -08:00
Kieran Prasch a07b9fa1e8 Documentation: Signer.from_uri -> Signer.from_signer_uri 2021-02-06 11:35:06 -08:00
Kieran Prasch d7b5a6114f Update getting started with characters documentation: bugfixes and inclusion of signers API. 2021-02-06 00:30:27 -08:00
Kieran Prasch 8df75210a9 Move worker best practices to a standalone doc 2021-02-05 14:13:53 -08:00
derekpierre d4c218547f Random edits. Also fixed broken links. 2021-02-05 14:47:03 -05:00
derekpierre a19da053d1 Add some context information about NU and its uses. 2021-02-05 12:35:13 -05:00
derekpierre 72899513b3 Clarify FAQ to explain that participation in WorkLock is closed. Also remove CoinList FAQ entry. 2021-02-05 12:26:39 -05:00
derekpierre 0285153c44 Collapse Python API and Contracts API into one APIS section in sidebar. 2021-02-05 12:26:23 -05:00
derekpierre 3b6d47dfe3 Mostly reordering of specific page content; addition of helpful/contextual links. 2021-02-05 12:25:39 -05:00
Kieran Prasch 9965ea33d6 Include all NuCo seednode endpoints in getting started docs 2021-02-04 22:55:20 -08:00
Kieran Prasch 792f2095da Remove beta development stage warning; Thin out staker and worker overviews. 2021-02-04 20:34:03 -08:00
Kieran Prasch 263960502e Detailing the worker doc to include mentions of max gas price and cautions about autopilot. 2021-02-04 20:18:34 -08:00
Kieran Prasch 5ca18af778 Remove admonition regarding lost or compormised worker keys until a stronger reccomendation can be made. 2021-02-04 19:48:38 -08:00
Kieran Prasch 77f66513a6 Respond to RFCs for PR #2463 2021-02-04 19:43:19 -08:00
K Prasch e49e1f2045
Apply suggestions from code review
Thanks for the reviews @mswilkison ! :-)

Co-authored-by: MacLane S Wilkison <maclane@nucypher.com>
2021-02-04 16:00:14 -08:00
Kieran Prasch af0ffea572 Expands best practices section of worker doc 2021-02-04 14:36:47 -08:00
Kieran Prasch 4ba7a9179d Details and emphasis 2021-02-04 10:39:51 -08:00
Kieran Prasch bda81f893d Dissolves CLI Subsection 2021-02-04 10:39:51 -08:00
Kieran Prasch 8f23bb2450 Expand testnet docs in thier individual domains 2021-02-04 10:39:51 -08:00
Kieran Prasch da51afd987 Port ethereum network deployments references to docs 2021-02-04 10:39:51 -08:00
Kieran Prasch 346108f19e Basic command reference tables for every CLI entry point. 2021-02-04 10:39:51 -08:00
Kieran Prasch 0b3e579c60 Iterating on documentation improvements: structure, running a worker, Expand mentions of signers. 2021-02-04 10:39:51 -08:00
Kieran Prasch 12ed69d15c Expand worker guide favoring docker commands, and demonstrating worker qualification. 2021-02-04 10:39:51 -08:00
Kieran Prasch dade42af6a Include NuCypherKeyring kwarg for restoration snippet in getting started 2021-02-04 10:39:51 -08:00
Kieran Prasch 3921dca868 Removes Interactive ursula mode from docs; Reccomend Docker. 2021-02-04 10:39:51 -08:00
derekpierre eaf3b73c23 Update docs dependencies instruction based on modifications to setup.py; Minor text changes. 2021-02-04 10:39:51 -08:00
Kieran Prasch 3ebcb9cd29 Complete deprecation of guides 2021-02-04 10:39:51 -08:00
Kieran R. Prasch 82b7db2186 Another take on the documentation's introductory statements. 2021-02-04 10:39:51 -08:00
Kieran R. Prasch db3165baa3 Reorganizes documentation categories; Thinning and focus on what's important. 2021-02-04 10:39:51 -08:00
Kieran R. Prasch 573cfa4989 Extricate documents that are not guides from the 'guides' section of the docs. 2021-02-04 10:39:51 -08:00
Kieran R. Prasch 8fca74d69c A few clarifications on common snags. 2021-02-04 10:39:51 -08:00
Kieran R. Prasch cdba619595 Revise stakking guide overview for completeness 2021-02-04 10:39:51 -08:00