Giter Club home page Giter Club logo

Comments (7)

mschinis avatar mschinis commented on July 20, 2024

picking this one up, I'm going to add additional meta tags using ember-cli-meta-tags.

from ember-api-docs.

oskarrough avatar oskarrough commented on July 20, 2024

@mschinis did you get going or maybe I can help?

I'd also like to remove the tomster open graph image. It takes up a lot of unnecessary vertical space as links are shared. We could replace with a little description, if that's useful.

from ember-api-docs.

toddjordan avatar toddjordan commented on July 20, 2024

@oskarrough go for it :-)

from ember-api-docs.

oskarrough avatar oskarrough commented on July 20, 2024

Alright! I looked at it and it seems meta tags are already setup, just a few missing things.

Are you OK with removing the tomster, too? Would be great to have a Slack chat with useful descriptions instead of the logo over and over again.

from ember-api-docs.

sivakumar-kailasam avatar sivakumar-kailasam commented on July 20, 2024

I find the guides urls to be descriptive on slack. Can you please use that to cross verify? The logos themselves might not be the root cause for the lacking experience

from ember-api-docs.

oskarrough avatar oskarrough commented on July 20, 2024

Hey @sivakumar-kailasam, what do you mean by cross verifying the URLs? :)

I think what we have to do is

  1. make sure there are meta descriptions where possible
  2. remove huge tomster logo

I agree that the logo isn't the root cause but it will nicer to share API links without it as it wastes 300px every time…

I noticed that the API returns descriptions filled with HTML. I'll make a helper to strip it out or do we have clean descriptions without markup? Example here in data.attributes.description https://ember-api-docs.global.ssl.fastly.net/json-docs/ember/3.2.0/classes/ember-3.2.0-ComputedProperty-a0c6b9793e.json

from ember-api-docs.

sivakumar-kailasam avatar sivakumar-kailasam commented on July 20, 2024

I meant cross verify the meta tag descriptors used on both pages :) You can probably add the helper to extract the text description.

from ember-api-docs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.