Conversation
Fix mycelium RPC endpoint
Update mycelium network ids
Remove --public-key from quickstart
Callout that automatic restarts should be disabled when reaching halting height
Add section about IPC upgrades
raulk
left a comment
raulk
left a comment
There was a problem hiding this comment.
Let's keep the images out of this repo to avoid bloating git clones. If they were light design/architecture diagrams, I wouldn't mind hosting them here. But not worth it for unoptimized tutorial screenshots.
I'd suggest the following:
- Keep media assets in the original docs repo, and embed them in the Markdowns using a GitHub URL.
- Rename the images to self-descriptive names. Right now we have series of
metamask (1).png,metamask (2).png... files.
|
@raulk Not bloating the repo makes sense. |
|
@maciejwitowski it won't because we'll be squashing this PR in. You can migrate the assets by adding a commit to this PR. |
maciejwitowski
force-pushed
the
maciej/docs
branch
from
1eba851 to
e0127e7
Compare
maciejwitowski
force-pushed
the
maciej/docs
branch
from
e0127e7 to
f605dae
Compare
|
@raulk Please check again. The docs website is already running from this branch https://docs.ipc.space/ |
|
After this branch is merged I'm gonna switch docs website to use |
There was a problem hiding this comment.
This looks fine as a starting point, even though the content needs significant revision.
Just one question before I merge this: how does editing via the GitBook web interface work in this case?
We absolutely don't want (a) the GitBook bot committing directly to this repo, or (b) the GitBook bot to appear as a Git author anywhere.
…rent docs (#1040) This pull request aims to enhance the existing documentation by introducing a new section on how it works and updating the benefits overview to provide clearer and more comprehensive information to the users. The changes include: Addition of a new section covering how IPC works, detailing its purpose and usage. Updates to the benefits overview, highlighting the key advantages and improvements of the current system. These improvements are intended to make the documentation more user-friendly and informative, aiding users in better understanding and utilizing the features of our product.
raulk
changed the title
raulk
changed the title
10 participants
At the moment, IPC docs are in the separate repo https://github.com/consensus-shipyard/docs
We want to simplify them by adding to this repo. Since in this repo
docsfolder already exists, they were put indocs-gitbook. The structure and naming of docs can be easily updated later.Next, the migrated docs are used to render the gitbook page. I created this separate gitbook space for the purpose of checking. It will replace the main one once this PR is merged.