osmosis-labs / docs Goto Github PK
View Code? Open in Web Editor NEWOfficial Documentation for Osmosis.
Home Page: https://docs.osmosis.zone
License: Apache License 2.0
Official Documentation for Osmosis.
Home Page: https://docs.osmosis.zone
License: Apache License 2.0
currently https://github.com/osmosis-labs/docs/blob/main/developing/rocksdb.md is an orphan doc, and not referenced anywhere in the website
does it have any value? shall we remove it completely, or add it to https://github.com/osmosis-labs/docs/blob/main/developing/README.md ?
side note: if it has value, it's a bit surprising UX that Osmosis executable does not include rocksdb by default but asks devs to install rocksdb manually separately. What's the rationale behind that decision?
As @jonator suggested, we should provide a page that links people interested in contributing to the "good first issue" page that GitHub provides
Example:
https://github.com/osmosis-labs/osmosis-frontend/contribute
We need to update awesome-repo and keep it up to date.
The following pages I’m not 100% sure where to put them under yet.
Also, I think we need to create a new page for:
right now docs only show instructions for setting up cosmovisor service, need to make a tab to choose between cosmovisor and osmosisd
Document basic guide on how to set up and maintain a relayer
We need to create a page that explains the different folders within the data folder and their respective idiosyncrasies.
As mentioned here: osmosis-labs/osmosis#781
Background
We don't have any documentation/guidelines for releasing our projects. As a result, it takes a lot of time to onboard on that. We should have the sequence of steps and rules documented so that everyone is consistent and new contributors can understand the process quickly.
Relevant discussion on Slack: https://osmosis-network.slack.com/archives/C027ELA290B/p1643991656792299
Acceptance Criteria
This is a continuation of the issue that was originally created on the osmosis repo
Modules not TODO:
Unsorted:
This is an epic to capture the different components needed to help developers build with Osmosis.
A continuation of the old issue that was originally opened in the osmosis repo
We need to hunt down all documentation from other repos, including front-end and add them to the official docs. A follow up will be needed in to then remove these docs from the original source and link them to the official docs.
Right now the crawler runs form a VM on Adam's account. We would like to move it to a Git action. Documentation on how to run it here:
https://osmosis-labs.atlassian.net/wiki/spaces/OL/pages/295173/Algolia+Search
This file:
overview/terminology.md
This text:
Osmosis’ design includes two mechanisms to incentivize long-term liquidity: exit fees and bonded liquidity gauges
The "exit fees" and "bonded liquidity gauges" links are not working.
Other than that, the glossary is well written and helpful. Keep up the good work.
Write a set of starter guidance for new developers to get up to speed quickly. The pain really comes from my experience with onboarding in past weeks that, as someone not so familiar with go/make, I had a super hard time to even build and run tests on osmosis codebase.
cross referencing osmosis-labs/osmosis#891 to here. We can include those suggestions (which is more in-depth than the starter kit) from @ValarDragon as well.
We can break down the effort into smaller one if needed.
Needs to be added, see https://evmos.dev/guides/keys-wallets/multisig.html
Add https://github.com/osmosis-labs/osmosis/tree/main/x/superfluid/spec to docs.osmosis.zone.
In order to reduce duplication. I will add a step to the doc's build action which will automatically copy the latest docs from x/superfluid/spec and publish it on the official docs.
We should have a config section that breaks down what each of these files do along with recommended settings
Use this as reference:
osmosis-labs/osmosis-frontend@85afa61
I realized that the scraper github action runs too quickly after the main branch is updated and therefore doesn't index the changes properly unless it is manually rerun after the pages build and deployment is finished
Using the clipboard button adds and extra space at the very end of the command once executed. This sometimes creates issues when trying to execute a multi step command (See https://docs.osmosis.zone/developing/keys/tmkms.html#prepare-tmkms-dependencies the rust command for an example)
https://github.com/osmosis-labs/docs/blob/main/developing/cli/README.md seems to be yet another orphan file that is not referenced anywhere. Also missing a few hyperlinks for bullets like "create a wallet"
AFAIU, README in this repo is used more as a group page where it may have multiple sub pages, like https://github.com/osmosis-labs/docs/blob/main/developing/modules/README.md, but this one in cli
folder is not serving that purpose and thus seems to be good to remove.
Thoughts? @daniel-farina @ValarDragon
add a PR template for osmosis docs repo, the PR template will ask requesters to fill in necessary info which will help reviewers to learn the context faster. The template will also force following the same standard going forward
Created this task from osmosis-labs/osmosis#581 in order to track. This is related to front-end but it's part of the overall documentation effort from osmosis-labs/osmosis#581
This guide is meant to get dApps developers up and running quickly.
@xiangan
As discussed earlier. I have put together an outline for the first quick guide on building dApps in Osmosis. As you become familiar with the tooling we will iterate and improve the guides.
Repo: docs
Branch: stage
Page to publish guide: https://stage-docs.osmosis.zone/developing/dapps/get_started/quick-guide.html
Please add more to this guide as we become familiar with the tooling.
From JeremyParish, he suggested the following list of articles to add to our documentation under the integration section.
I was thinking of having a page or section for many different things projects tend to ask questions about or need help with:
in this file at the rewards-estimation
section is missing the example (currently a Go parsing error)
Document RPC and LCD endpoints. Please share any information available on this ticket and then @daniel-farina can add it to the docs.
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.