-
Notifications
You must be signed in to change notification settings - Fork 30
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
Rewrite documentation #971
Conversation
Co-authored-by: Nicolas Dupont <nicolas@opentermsarchive.org>
Remove all references to a single instance
#RIPTwitter
The header and introduction will be moved to an organisation README The ToC will be re-introduced if the size of the final document warrants it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have some feedback but nothing blocking, well done!
@@ -12,7 +12,7 @@ First of all, thanks for taking the time to contribute! 🎉👍 | |||
- [Practices](#practices) | |||
- [Errors handling](#errors-handling) | |||
|
|||
--- | |||
- - - |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It doesn't really matter but I'm curious to know what is the reason for this change in the format of <hr />
?
As a reminder, markdown files will be linted when they are migrated to the docs
repository, and the following rule will apply: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md035---horizontal-rule-style
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I personally prefer using the style with spaces for horizontal ruler, because it is unambiguous with the underline title style:
This is not a title.
---
This is under a ruler.
is less clear to me than
This is not a title.
- - -
This is under a ruler.
and in case of a forgotten whitespace, this will still render as a ruler:
This is not a title.
- - -
This is under a ruler.
whereas this won't:
This is not a title (but is rendered as such)
---
This is under a ruler.
As for rule MD035, we can define the string to whatever we want, so if you agree with my point of view we could very well define it to - - -
🙂
@@ -0,0 +1,22 @@ | |||
# Governance |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not simplify the naming of the file by governance.md
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -0,0 +1,21 @@ | |||
# How to explore a history of versions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why the file is named howto-...
and not how-to-...
? (it may be that my English is not good enough)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As explained in #971 (comment), the idea was to have categories as prefixes, thus making them stand in a single “namespace” of sorts. I agree this could be improved.
Co-authored-by: Clément Biron <clement@opentermsarchive.org>
Co-authored-by: Clément Biron <clement@opentermsarchive.org>
Do not do it in the codebase, API and CLI yet as it would trigger a major and this branch is focused on rewriting documentation
Add example to remove property
The README of this repository was initially created as a the first public presence of Open Terms Archive, before a website was even created. It contains a mix of political statements, user documentation and technical documentation, and is overall obsolete. Beyond outdated contents, the growth of the ecosystem, the maturity of the website and the architectural choices of moving slowly from a monolithic system to a more modular approach to keep the code maintainable, all mean that the documentation should now be focused on the technical aspects of the engine, and the user documentation kept separate.
This changeset:
docs
folder containing user documentation, that will be at some point moved to the recently createdOpenTermsArchive/docs
. This documentation is consolidated from different parts of this repository and other relevant repositories,If merged, the following subsequent actions should be taken:
contrib-declarations
.Co-authored with @Ndpnt.
Fixes #811 #963.
Relates to OpenTermsArchive/contrib-declarations#696 (comment)
Depends on OpenTermsArchive/contrib-declarations#746.