decred / dcrdocs Goto Github PK
View Code? Open in Web Editor NEWDocumentation for Decred.
Home Page: https://docs.decred.org
License: ISC License
Documentation for Decred.
Home Page: https://docs.decred.org
License: ISC License
https://wiki.decred.org/Decred_Constitution
This appears to be missing in dcrdocs.
We need to update the theme according to the new Design specifics.
You can find informations on how to customize themes for mkdocs on their user-guide at
http://www.mkdocs.org/user-guide/custom-themes/
Therefore the template have to be created into a single directory which contains all needed assets, HTML, CSS, JS and FONTS. This directory should be created next to the mkdocs.yml configuration file in the document root.
The requirement is to disclaim JS if possible. And if JS have to be used it have to be served locally and the Sites usablility should be ensured, even when NoScript browsing is enabled.
You can activate the new template by editing the mkdocs.yml and point to the directory with the following parameters:
theme: null theme_dir: YOU_THEME_DIRECTORY/
Need to agree on a "map" for our Golden Path. How does everyone interpret the words "Golden Path"?
Due to too many spaces the markdown isn't converted into HTML properly.
Decred and Company 0 blogs have some articles on Decred. I'd like to save them all locally.
Right now I use this:
wget \
--timestamping \
--recursive \
--page-requisites \
--convert-links \
--accept html,png,jpg,txt \
--reject-regex "/page/|/feed/|/tag/|/category/|/author/" \
--wait=1 \
https://blog.companyzero.com/
Obviously it is complex, slow, redundant, incomplete (if external images are linked), has no integrity protecteion and cannot be quickly synced to pull latest blogs.
Much cooler would be to just git clone
.
Working examples of Git-based blogs:
For more motivation see Joanna's My New Git-based blog.
Sorry if this repository is a wrong place for this issue.
P.S. I wish the same for old Conformal blog, it had some articles on btcsuite.
Create guide for using Decredition
Update links and filenames.
Brought up by praxis.
Having examples for other mining pools may help spread out hashing power.
Need to change lists so that they display normally, instead of always bold.
The generated html files do not need to be kept in the repo. They can be generated before deploy with:
mkdocs build
and then served statically as normal. No reason for them to be in the repo. Also, having them in the repo complicated rebases and makes it hard to have more than one PR going at the same time.
Search bar is huge. Seriously. The layout looked just fine in the default theme (example).
Create a page for all various third-party tools
Create guide for using Paymetheus
Create video tutorials for installation
Include explanation on how ticket fees are calculated
At the moment there is no Decred entry on wikipedia.
As a low level entry point to Decred this can be very useful.
0.8.0 just came out, lets point everyone to it.
Steps for dcrinstall and zipped binaries for Windows, OSX, and Linux on a single page.
Information found in this forum post (amongst many others):
https://forum.decred.org/threads/the-projects-commitment.730/
Would be nice to see the size of the dev pre-mine, c0 pre0mine, why the pre-mine was split that way. Also an explanation of the restrictions on devs/c0 selling/staking their pre-mine.
Hello, while I was following your Proof Of Stake guide from docs.decred.org I experienced some problems and couldn't vote my tickets. I then figured out that you had to add --enablestakemining when starting your wallet but the documentation doesn't state this on that page. Even though it may be a very basic thing, its hard to figure out that you had to add that when it doesn't write it on the documentation. It would be helpful for other people following the documentation that you add the --enablestakemining command.
Currently we have some documentation on the wiki with the rest on dcrdocs. Need to move that information from the wiki over here so it can be closed.
The first thing I want to do after typing something in the search box and finding useful results is to hit down arrow or enter to navigate to a selection.
Would anyone else find it useful if I added that?
Some users have suggested they would prefer the docs website to have a non-javascript option. This theme may be useful although I haven't looked closely at it:
Create guide for running a node on testnet.
This should be included in #77
Numerous support issues have been related to plugging the same seed into multiple wallets, web wallet, etc. and using them concurrently.
This is unsupported and causes problems when the wallets fail to receive/see all transactions/addresses.
Should strongly recommend "new wallet, new seed".
Add a support page - "Where To Get Additional Help". Show the directory that coin_artist made in Slack, add instructions for getting an invite to Slack, link to forums, IRC, etc,...
Create a testnet hard fork voting guide for 0.8.0.
.col-md-9 li {
font-family: 'Source Sans Pro', sans-serif;
font-size: 1.8rem;
color: #132f4b;
font-weight: 600;
}
Update PoW page with gominer guide
I'm not sure how this would tie in with #38. You would need to provide testnet examples everywhere which is kind of messy. I think it's important to make it clear that you can test/play around with Decred without spending money.
Probably the most relevant section is 'Obtaining DCR' which should mention the new testnet faucet:
There are two bits of js and css that are loaded externally. Those should be moved into the repo and self-hosted.
We need to decide on the best way to provide translated docs.
mkdocs does not support anything natively (see mkdocs/mkdocs#617 for details).
That leaves us with a few options.
dcrdocs/
en/
es/
ru/
...
Each with a full set of docs. Then we could serve the default (en) as docs,decred.org and any other language in a subdomain (ru.docs.decred.org) and provide some internal links. This is more work on the part of the admin.
3. Make a sub dir in the current structure for translations and server those in the same domain as docs.decred.org/ru/
or something like that.
4. Any other ideas I haven't thought of?
Create a "Golden Path" single entry point guide for new users
Update existing docs with newest CLI functionality
The contributing guidelines (most related to how to use git and github) for decred should be added to the docs.
The current version is at:
https://gist.github.com/jcvernaleo/aa3f6c216f3df1f9c6b62d7f59a2a469
New window for stake pool setup and ticket purchasing needs to be documented.
There is a link to this github repo the docs website but we still might want to make it a little clearer that we want both issues and PRs on the docs repo and that the docs site is not just some static thing but something we want people to help improve.
That said I'm not sure how we can best point that out which is why I've put an issue here rather than just going and changing it and doing a PR myself.
Technical documentation is continually evolving outside of standard release cycles and as such version numbers are either complex, confusing or plain irrelevant. Github tracks the changes to documentation so I suggest we remove the version number from the footer.
Anyone disapprove of the centering of images? I don't think it's possible to do this via markdown syntax but I know that we can use raw HTML/CSS to insert images in the docs. Can we add a centered img class to the base.css file? Would have to have these properties:
img.centered {
display: block;
margin-left: auto;
margin-right: auto;
}
Hello, I have an email stating that "
You recently signed up for the Decred airdrop. The project is delighted to let you know your application has been successful!" I followed the steps at the time and created a seed and hex address. When I go to https://wallet.decred.org/#/ to try and create a wallet I keep getting an error.
I deleted the generic wallet that had already existed. There was no balance on that first wallet. I then tried to create the wallet with the seed by "create a new wallet." When I go to advanced options; there is nothing that specifies a seed so I used "Specify Recovery Phrase." however, when I input the seed here and name my wallet etc, I get an error that says, "Error creating wallet: Network connection error."
Can you guys please advise me on this. Am I doing the correct steps to generate this wallet? Is the network just down at the moment? If yes, when will it be back up?
Very Respectfully,
Matthew Spano
As mentioned in the design PR #53, I very much prefer the older dark themed site to the new site with lots of white background on it. I think we should either go back to lighter text on a dark background for the main body of the text or at least have it as an option.
Some support https now and one has a new URL.
Need to add design brief that chappjc found. Assign this one to me.
dtb001.pdf
Update FAQ with VERY basic info such as how to send and receive Decred
https://docs.decred.org/
https://wiki.decred.org/Main_Page
Why are those two separate and not one thing? What purpose each of them serves? When should I visit the one over the other?
Create guide on using ticketbuyer.
Might be best to wait for functionality to be merged with dcrwallet.
Create guide on using dcrinstall
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.