docs: consolidate README & CONTRIBUTING & remove other READMEs #1333
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| The API reference at (<https://docs.apify.com/api/v2>) is built directly from the OpenAPI specification of our API, versioned at https://github.com/apify/openapi. | ||
| ## Style guide |
There was a problem hiding this comment.
Again, "writing style guide" maybe?
README.md
Outdated
| If you add arrows or other indicators to the screenshots, they should be red for high contrast and visibility on the light theme. | ||
| - For contribution questions, see our [Contributing Guidelines](CONTRIBUTING.md) | ||
| - For technical issues, create a GitHub issue | ||
| - For documentation feedback, use the feedback form on our documentation pages |
There was a problem hiding this comment.
Is there a direct link we can add here?
README.md
Outdated
|
|
||
| If you add arrows or other indicators to the screenshots, they should be red for high contrast and visibility on the light theme. | ||
| - For contribution questions, see our [Contributing Guidelines](CONTRIBUTING.md) | ||
| - For technical issues, create a GitHub issue |
There was a problem hiding this comment.
If I recall there's a direct link to create new issue in a repository
Co-authored-by: Adam Kliment <[email protected]>
|
Ok I guess that might be an issue off the top of my head I see some solutions tho
(it kind of looks like one solution with two aproaches now...) any thoughts? |
|
I don't like the idea of having "deprecated readme" somewhere, I would like to see everything contribution related in the contributing guide, including how to work with the spec file. |
CONTRIBUTING.md
Outdated
| ```nginx | ||
| server { | ||
| listen 80; | ||
| server_name docs.apify.loc; |
CONTRIBUTING.md
Outdated
| - use *Bold* for UI elements | ||
| - use **Italics** for emphasis | ||
| - use `code` for inline code, by using back-ticks (\`\`\) | ||
| - use code blocks with language specification | ||
| - usd [code tabs](https://docusaurus.io/docs/markdown-features/tabs) whenever you want to include examples of implementation in more than one language | ||
|
|
||
| In the title (`cardItem`), don't just give the article's name. Phrase the title in a way that answers a question or fulfills a goal the user might have. | ||
| 2. Documentation elements: | ||
|
|
||
| For example: | ||
| - Use [admonitions](https://docusaurus.io/docs/2.x/markdown-features/admonitions) to emphasize cruciac information, available admonitions are: | ||
| - note | ||
| - tip | ||
| - info | ||
| - caution | ||
| - danger | ||
| - Use code tabs for multiple languages |
There was a problem hiding this comment.
this feels misindented too, we use 4 spaces, not 3.
| id: | ||
| description: The resource ID |
There was a problem hiding this comment.
this as well, 4 spaces for first level but 6 spaces for second one
|
@netmilk are we actually missing in this version any info that is in currently scattered READMEs? I tried to go through each README and incorporate them properly into both the new README & CONTRIBUTING I didn't find in current README any specific mentions of redocly, just how to work with OpenAPI schema, and those have been moved over |
No description provided.