Comments (19)
TypeDoc looks promising, but has issues of its own. We'll definitely need a custom theme, and rendering markdown files doesn't seem to be supported easily/natively (TypeStrong/typedoc#174 and related issues).
Another problem is that the API docs need to be integrated into the existing site structure. I didn't dive in too deep in the current building process, but I expect that this will be too involved for the moment.
from olddocumentationsite.
Any chance we could create a gitter for this repo and get the team to join there? Would be great if I could just throw in some question now and then about the current structure without having to abuse the issues as a Poor Man's Chat.
from olddocumentationsite.
I'm not used to Gitter but I do like chatting here:)
from olddocumentationsite.
Well, this is fun. The gist of the classes markup is created in the various writers as markdown, then later on rendered. These parts need to be moved to pug mixins. Strategies:
- Extract from builder and compiler script.
- Pros: Easier to spot individual components.
- Cons: Working in multiple files, lots of interdependencies. Also, maek brain hurrt.
- Reverse engineer from compiled html files.
- Pros: Porting is fairly straight forward.
- Cons: Tag soup, might miss certain cases.
from olddocumentationsite.
Might be a good idea to get rid of any markup in the scripts and instead pass everything through pug templates. That would include any customizations to the markdown renderer output.
from olddocumentationsite.
As long as we can keep the content into md I'm fine with all required changes
from olddocumentationsite.
As long as we can keep the content into md I'm fine with all required changes
Yeah, I'm definitely not touching those. On the contrary, I think we can move some metadata from statics.json into the md files. But that's a project for another day.
from olddocumentationsite.
lol
from olddocumentationsite.
I think we can use a pug filter to automatically link classes. That way we don't have to pass around paths.
from olddocumentationsite.
Enums in current docs are slightly broken: https://doc.babylonjs.com/classes/3.1/orientation
What should this look like? Skip the second heading and simply print "enumeration" inside a paragraph?
from olddocumentationsite.
Constructors: https://doc.babylonjs.com/classes/3.1/action
Is the whole constructor signature really supposed to be wrapped in h2? Looks like an oversight / error to me?
from olddocumentationsite.
Agree
from olddocumentationsite.
Btw, I was wondering (again, project for another day): Perhaps we should handle all redirects through express (we could still keep them in a json)? That would allow us to keep tabs on the ones that are actually needed (and purge obsolete ones after a while). Additionally we could implement some fuzzy logic in case of 404's or display a page with search results (while still issuing a 404, of course). This also lessens the dependency on Netlify's redirect feature.
from olddocumentationsite.
let's discuss it after this one is done ;)
from olddocumentationsite.
Should we mark 3.1 class pages as canonical URLs for 3.0 class pages, so that Google will only find the current version?
from olddocumentationsite.
This is an excellent idea.
from olddocumentationsite.
Should we mark 3.1 class pages as canonical URLs for 3.0 class pages, so that Google will only find the current version?
Obsolete, since we're dropping 3.0 API docs (see comment). Add redirects from /classes/3.0/*
and /classes/3.1/*
paths to /classes/stable/*
instead, with a final catchall to the /classes/stable
index page.
We might also want to consider changing /classes
to /api
.
from olddocumentationsite.
agree
from olddocumentationsite.
Done:)
from olddocumentationsite.
Related Issues (20)
- Match code style in Parametric Shapes tutorial to that of Playground example
- <SceneComponent /> should be <BabylonScene .../>? HOT 1
- Babylon 101 Video Tutorial Series HOT 1
- Dead links on the "Discover Basic Elements" tutorial page (Babylon101)
- Display first PG from the doc in the PG search
- Filter search for 'VR' should bring up WebXR docs HOT 4
- Arc Rotate Camera Contradiction in Docs HOT 1
- There are 89 broken links in the documentation site HOT 4
- Recreating the default configuration for the viewer has an error HOT 1
- Page not found errors on local version of Documentation HOT 2
- ArcRotationCamera.setTarget has different argument type than set target() HOT 4
- Animation blending PG in docs is broken HOT 1
- Missing info in https://doc.babylonjs.com/how_to/webxr_session_manage.
- "How to use Babylon.js with ReactJS" wrong links HOT 1
- 'jsut' Spelling mixed up issue on document doc.babylonjs.com/how_to/webxr_augmented_reality page HOT 2
- Incorrect method for customizing camera inputs HOT 2
- code in docs for Babylon React hook doesn't dispose scene on cleanup HOT 4
- SEO - Fail Doc Builds if missing Page metadata
- Clean Up Playground Namespaces HOT 1
- Turn NME doc page into an NME doc chapter HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from olddocumentationsite.