Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Improve doc #416

Closed
chevdor wants to merge 5 commits into from
Closed

Improve doc #416

chevdor wants to merge 5 commits into from

Conversation

@chevdor
Copy link
Contributor

@chevdor chevdor commented Jul 24, 2018

Improve doc

  • convert some md to adoc
  • include contrib docs to the main readme
  • add readme for some packages and include them

I don't like duplication so the .adoc files mostly fetch the doc from Cargo-toml or from the crate doc. It could look nicer but that provides a fair doc for now.

The result is similar to the attached PDF (may not be the very latest one...)
README.pdf

@chevdor chevdor added I6-documentation Documentation needs fixing, improving or augmenting. M3-docs labels Jul 24, 2018
@chevdor chevdor changed the title WIP: Improve doc Improve doc Jul 24, 2018
@gavofyork
Copy link
Member

gavofyork commented Jul 24, 2018

i think it might be sensible to wait until we've split apart the repos before trying to link together all the docs?

@chevdor
Copy link
Contributor Author

chevdor commented Jul 24, 2018

Yes, that´s why I skipped substrate: https://github.com/paritytech/polkadot/pull/416/files#diff-49b095a76d035c47b4136b1da5a3b7d1R7
Do you plan on splitting more than just substrate ?

For the rest, the doc (mainly just the new README.adoc) can follow the refactoring and we´ll mainly have to add/remove/fix some includes.

I don´t plan on doing much more on the topic for now unless there is a fix required.

@chevdor chevdor added the A0-please_review Pull request needs code review. label Jul 27, 2018
@gavofyork
Copy link
Member

gavofyork commented Aug 1, 2018

Yeah - at least the runtime will also be split out into a separate repo, possibly substrate-demo, too (though that could also just stay with substrate).

@chevdor
Improve doc
f0f5831 
- convert some md to adoc
- include contrib docs to the main readme
- add readme for some packages and include them
@chevdor
Copy link
Contributor Author

chevdor commented Aug 3, 2018 •
edited
Loading

I don't have access to solve this conflict.
The conflict comes from the fact that CONTRIBUTING.md was modified on master but deleted in this branch.

The conflict can be fixed:

  • the CONTRIBUTING.md file can be totally deleted
  • I brought in the changes from @gnunicorn (68f83a2) into the renamed .adoc

@chevdor chevdor requested review from gavofyork and gnunicorn August 3, 2018 15:52
@gnunicorn
Copy link
Contributor

gnunicorn commented Aug 6, 2018

@chevdor you should be able to fix the conflict by rebasing your changes on top of master.

@chevdor
Copy link
Contributor Author

chevdor commented Aug 6, 2018

@gnunicorn ok will do and try to get this one done.

@ddorgan ddorgan closed this Aug 25, 2018
@ddorgan ddorgan reopened this Aug 25, 2018
@gavofyork gavofyork removed the I6-documentation Documentation needs fixing, improving or augmenting. label Aug 28, 2018
@gavofyork
Copy link
Member

gavofyork commented Sep 5, 2018

Lots of conflicts. Reopen once sorted, if desired.

@gavofyork gavofyork closed this Sep 5, 2018
@chevdor
Copy link
Contributor Author

chevdor commented Sep 11, 2018

Superseded by #700 and paritytech/polkadot#16

liuchengxu pushed a commit to chainx-org/substrate that referenced this pull request Aug 23, 2021
@koushiro
Rename revoke_withdraw and force_set_binding (paritytech#416)
a0df32c 
Signed-off-by: koushiro <[email protected]>
liuchengxu pushed a commit to autonomys/substrate that referenced this pull request Jun 3, 2022
@nazar-pc
Merge pull request paritytech#416 from subspace/bootstrap-nodes-tweaks
181133a 
Bootstrap nodes tweaks
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@gavofyork gavofyork Awaiting requested review from gavofyork

@gnunicorn gnunicorn Awaiting requested review from gnunicorn

Assignees

No one assigned

Labels

A0-please_review Pull request needs code review.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@chevdor @gavofyork @gnunicorn @ddorgan