Skip to content

creation of Archived section for historical versions eg v0 #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 21 commits into from
Jun 28, 2024

Conversation

ross-spencer
Copy link
Member

Just opening this up for discussion @Christian-MK

@ross-spencer
Copy link
Member Author

  • Do we want to roll with archive? It is often a loaded term.
  • My vote would be to not have the IOG part here.
  • One of the more important parts of the history/archive is to list previous policy IDs. Maybe we can also have another page that lists these? Example structure:
# orcfax policies

Historical oracle policies are listed here. 

## current

* mainnet
* preprod

## legacy

### v0 

V0 uses a legacy datum format, see "archived resources" for how to interpret the data previously put on-chian.

* mainnet
* preprod

## v1

* etc.
* etc.

@Christian-MK
Copy link
Collaborator

Christian-MK commented May 23, 2024

@ross-spencer

  • Do we want to roll with archive? It is often a loaded term.

Not married to anything, suggestions?

  • One of the more important parts of the history/archive is to list previous policy IDs. Maybe we can also have another page that lists these? Example structure:

other policy ID's than are listed on this page?
Preprod: https://github.com/orcfax/docs/blob/Archived-section/docs/developer-manual/archived.md#preprod
Mainnet: https://github.com/orcfax/docs/blob/Archived-section/docs/developer-manual/archived.md#mainnet

Or is it that you wish to have these stand alone, away from any context or other resources shared relating to historical versions?

@Christian-MK
Copy link
Collaborator

  • Example structure:

Fine with this structure but want clarity on the previous question re the other content (eg context)

@ross-spencer
Copy link
Member Author

ross-spencer commented May 26, 2024

Or is it that you wish to have these stand alone, away from any context or other resources shared relating to historical versions?

Yes please! For those reasons, just free from the additional documentation that existed. The current page is fine as is too, that is, more like you say, like an archive, I used the term archived resources above.

Archive vs. anything else?

For the policies, maybe "Legacy policies and smart-contract addresses" with the minimal context provided in the example?

@Christian-MK
Copy link
Collaborator

What an ugly commit history.. apologies. Evidence of me still learning how to efficiently use git.

@ross-spencer I have implemented your suggestion to trim down the policies page just to the bare minimum while creating a separate page for context and links.

Copy link
Member Author

@ross-spencer ross-spencer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Info about slots/blockheader here: https://github.com/orcfax/issues/issues/166#issuecomment-2191199360 just needs adding then merging.

LMK if you ever want to learn to rebase (to clean up commit histories)

NB. apparently I can't "approve" 🤷

@Christian-MK Christian-MK merged commit 292fd33 into main Jun 28, 2024
1 check passed
@Christian-MK Christian-MK deleted the Archived-section branch June 28, 2024 22:25
Christian-MK added a commit that referenced this pull request Jul 9, 2024
* creation of Archived section for historical versions eg v0

* seperation of content into policies & resources per feeedback

* header correction

* archived-resources, context for policies

* Update archived-resources.md

addition of incidents repo links

* markdown corrections and fixed links

* fixed utxo-1 link

* addition of start/end date context

* Update roadmap.md

Remove old timeline graphic

* Add files via upload

upload updated roadmap graphic

* removal of COOP and replace with Orcfax Protocol

* roadmap update

* correction of headings

* second attempt to fix headings

* Rollback docusaurus dependency

* removal of coop & replaced with orcfax protocol

* removal of coop references

* addition of policy IDs and contextual info

* addition of policy ids and context

* fix markdown

* stubborn lists

---------

Co-authored-by: Christian-MK <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants