Discussions
Suggest edits not available for /refecence pages
Why is "Suggest edits" not visible for pages in the API Reference?
There is often a lot of pages handwritten in this section.
Please fix ! :)
Posted by [email protected] almost 2 years ago
What is the best way to import a subdirectory of images and other
In the rdme CLI, I'm trying to import the MD folder that has an /images subdirectory. Is there another tool that can import bulk image and downloadable code samples?
Posted by Virginia Kelley almost 2 years ago
Is there a way to author in VS Code
Our team would like to continue authoring in Visual Studio Code and then let Jenkins pull the guide topics from our Git repository for staging/QA/GA. I did not see a way to add a CLI command to Jenkins or a plugin.
What's the best way to do this? (Lots of details please, we're experienced MD'ers...not ReadmeMD.)
Posted by Virginia Kelley almost 2 years ago
Improving Largest Contentful Paint (LCP)
When inspecting my site on Google Search Console, I noticed a large number of errors. These errors stem from our docs: <https://docs.budibase.com/> which we use Readme for.
The errors are predominantely around 404s and LCP - <https://web.dev/lcp/>
The image below highlights the issues around LCP. Any idea how I can improve this?
Posted by Joe almost 2 years ago
Is there a character limit for Glossary terms?
In the glossary term popup, is there a character limit? How long can they be? not sure if there is a best practice as well. Thanks!
Posted by Julia Berkovitz almost 2 years ago
Updating API specification doesn't work
I am doing a PUT request, tried both with a JSON and YAML, I'm getting a 503 error.
The tried specifications are valid.
`curl -X PUT -T "openapi/spec301.json" -u "$README_KEY:" "https://dash.readme.com/api/v1/api-specification/$SPEC_ID"`
Response:
```html html
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8">
<title>Application Error</title>
<style media="screen">
html,
body,
iframe {
margin: 0;
padding: 0;
}
html,
body {
height: 100%;
overflow: hidden;
}
iframe {
width: 100%;
height: 100%;
border: 0;
}
</style>
</head>
<body>
<iframe src="//readme.com/error"></iframe>
</body>
</html>
```
Posted by Marcin Szle almost 2 years ago
Using prefilled example values in curl "Try It"
Hello,
In the API Ref, your request params can be specified to have an example value, but the "Try It!" Curl/code request on the side does not have the body params prefilled unless you select in the dropdown. Is there a way to enable this? For example the path params get prefilled into the request, but not body.
Hope this can be resolved, thank you!
Posted by James Spaniak almost 2 years ago
Error 1014 on CloudFlare
Hi, My name is seongjin at Bithumb Systems.
I tried using custom domain, and got the error:
Error 1014 Ray ID: 711488c05fbc12ea • 2022-05-26 06:43:01 UTC
CNAME Cross-User Banned
What should I check?
Thanks
Posted by [email protected] almost 2 years ago
Slow loading endpoints
Hello there.
I have the following issue..
L5 swagger openapi endpoints imported into readme via file load very slow.
My question is does the file size matter, because when smaller sized file is imported every endpoint loads fast. And if the larger file is imported the endpoints load too slow?
Thank you in advance !
Posted by Deivid Handzhiev almost 2 years ago
ELIMINAR CUENTA
Hola, como hago para eliminar definit la cuenta, no comprendo como funciona
Posted by Teresa Cardozo almost 2 years ago