Coder Social home page Coder Social logo

bimdata / documentation-old Goto Github PK

View Code? Open in Web Editor NEW
8.0 8.0 3.0 19.02 MB

🗂 BIMData.io documentation repository

Home Page: https://developers.bimdata.io

HTML 19.73% Makefile 2.22% Python 4.47% Batchfile 2.25% Dockerfile 0.37% JavaScript 0.96% SCSS 70.01%
documentation

documentation-old's People

Contributors

amoki avatar cyrilbele avatar dependabot[bot] avatar francois-thierry avatar gabbimdata avatar kurtil avatar lrxgaelle avatar mere-teresa avatar romainmou avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

documentation-old's Issues

Interface - composant recherche "darkmode"

image

En darkmode je crois qu'on ne change pas les couleurs de la recherche. Je pense qu'en passant tout en blanc ça nous rÚgle le problÚme. Inutile de passer trop de temps dessus car on va trÚs certainement changer de plugin si j'ai bien compris.

Design: API Viewer page CSS is not accurate

https://developers-staging.bimdata.io/viewer/parameters.html

Parameters_and_methods
Parameters_and_methods_parameterse

  • le texte en rouge encadrĂ© : moche et illisible, autant dans la liste des Parameters au dĂ©but que dans chacun des mĂ©thodes ensuite
  • BIMDataViewer.removeCustomWindow(id) <== ceci est une mĂ©thode et tout ce qui est en dessous s'y rapporte (arguments, valeurs de retour et exemple), et on ne le comprend pas (ce point Ă©tait + clair dans l'ancien design)

Ce HTML est généré de mon cÎté via macros en RsT.


.. js:method:: BIMDataViewer.addCustomButtonMenu(id, options)

    Attach a button to the Options menu

    :param string id: ID of the Menu,
    :param object options: *Object* BIMViewerCustomButtonOptionsMenu
    :returns: void



Interface - problĂšme de marges

image

Romain à relevé à juste titre un problÚme de marges avec les balises code intégrés directement dans la doc. En effet à chaque fois on a une marge plus importante à droite qu'a gauche. Quand la balise se retrouve en fin de phrase juste avant un "." on voit vraiment que ça pose un problÚme de lisibilité.

Interface - darkmode : hover sur flĂšches de la sidebar

image

image

On va essayer de passer les hover sur les flÚches du menu en jaune. Actuellement elles passent en bleu foncé un peu comme le bouton du sign-up.

Tu-trouveras ci-joint le svg du nouveau picto que je suis en train de mettre partout. Toujours dans l'idée d'uniformiser l'ensemble de nos interfaces produit.

J'ai remarqué également qu'on avait un petit soucis de marge entre la flÚche et le texte.

arrow.svg.zip

Documentation-Utilisation de la roboto

J'ai remarqué qu'actuellement nous utilisions de la "roboto-slab" dans la doc. En fait j'utilise presque uniquement de la "roboto" (sans slab) en regular et medium. J'ai fait un test en utilisant uniquement de la regular partout et c'est pas mal du tout :) Il faut donc changer "roboto-slab" par "roboto" tout court.

Interface - taille font menu

image

image

J'ai l'impression qu'on avait dĂ©jĂ  rĂ©glĂ© ce truc lĂ  par le passĂ©. Actuellement sur la branche "feature-new-lib" je n'ai pas la mĂȘme taille des textes dans le menu de la doc et celui de la plateforme.

Interface - animation doc api

Lorsque l'on clic dans le menu, l'animation est archi lente, je trouve qu'on met beaucoup trop de temps pour arriver à l'endroit ou on veut aller au débat.

Il y a aussi un genre d'inertie au début de l'anim qui devient insupportable à force.

Possible d'accĂ©lĂ©rer l'anim ? On peut faire des tests et voir ce qui est mieux. C'est mĂȘme possible de ne pas mettre d'animation du tout.

Interface - bug double menu doc API

image

Actuellement les deux menus sont superposĂ©s. En vĂ©ritĂ© ça ne me pose pas de soucis si on garde une largeur de menu iso partoutdans la doc (je trouve ça mĂȘme plus correct).

J'ai également remarqué qu'on avait pas de Title sur cette page.

image

Interface - comportement breadcrumb dans cookbook

image

Je suis allé voir un peu partout pour tester le darkmode et par réflexe j'ai voulu utiliser le breadcrumb pour retourner à la page principale du cookbook. Le truc c'est que c'est impossible lorsque nous sommes dans "Create a backend-less application" et "Create a backend application" nous n'avons plus accÚs à "cookbook".

Add Ifc Access Token

Ifc Access Token

When using an application without users (through client_credentials auth), you may want to use BIMData viewer without exposing your application access token.

You can create a temporary access token for only one IFC, read-only or read/write.

To use them, your application needs the scope "ifc:token_manage"

You can create a token with endpoint https://api-staging.bimdata.io/doc#/ifc/createAccessToken
You revoke a token with endpoint https://api-staging.bimdata.io/doc#/ifc/deleteAccessToken
You can list all existing tokens for an IFC with endpoint https://api-staging.bimdata.io/doc#/ifc/getAccessTokens


On https://developers-staging.bimdata.io/tutorials/guided_tour.html

Without Users
Chose this way if you don’t want to use BIMData Connect users.

=> add a link to the Ifc Access Token page

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.