eosnetworkfoundation / docsgen Goto Github PK
View Code? Open in Web Editor NEWScripts for creating docs.eosnetwork.com pulls from various eos nf repos and builds static HTML to power website
License: Other
Scripts for creating docs.eosnetwork.com pulls from various eos nf repos and builds static HTML to power website
License: Other
Rename welcome to docs. Two parts to this request
only github artifact release notes should show up, release notes stored with markdown should be removed
New AWS load balancer and SSL layer
how to update documentation and style
Seems like we need a crawler.
Write a crawler of devdocs portal to perform analysis per URL. Will not summarize analysis across URLs, will not dedup content across URLS
use cypress , headless browser works everywhere
Title meta-data at top and it pushes down previous meta-data.
The replacement of text might not work when there is more then just content-title.
01_nodeos/05_rpc_apis/index.md
---
title: Rpc Apis
---
---
content_title: RPC APIs
link_text: RPC APIs
---
the nodoes plugins from openAPI. Need versions for those. config driven at this point.
Check for H1 tags in key repositories
Check to make sure code references exist for CDT and System Contracts
API RPC and other acronyms should be capitalized.
Example : https://docs.eosnetwork.com/leap/latest/nodeos/rpc_apis/
this is how a link to the function modify()
in the mandel.cdt reference documentation gets generated:
http://localhost:8080/mandel-cdt/group__multiindex.html#ga4b3556ef69c7faa917f185ae33a34442
the anchor seems to be a GUID which will be different each time the doc gets generated
we need these anchors to be fixed so we can use them in docs and link to functions reference documentation.
Later edit:
the GUIDs are generated the same way (fixed) all the time but we could improve
in CDT and EOS System Contract the doxygen/doxybook2 files fall into a resource directory fix by doing the following
add release notes for leap.
Found doxybook2 executable missing.
They should display 404 not found or similar for security reasons.
Starting an issue so we don't forget this work item. Need to know how to implement tracking, marketing tags, and any special features to support EU/CA privacy requirements.
Sometimes markdown file can have the same name
need roles, groups, and devdoc user to automatically build documentation on each release.
updates to get_info new endpoints send_transaction2, trace and compute
expect work coming in this direction
Example:
/action-reference/eosio.bios -> /reference/mandel-contracts/classeosiobios_1_1bios.html
Put this mapping in one location, may need to correctly handle release or API versions
NOTE alternative is to use algoria crawler.
Edit crawler/getLinks.js to crawl https://docs.eosnetwork.com/sitemap.xml
Mostly likely want to crawl in groups by first level directory. For example param of group=cdt would crawl
Filter out all /blog do not crawl those
Mostly likely want to crawl latest stable release, so you may need a version param as well.
Having our own crawler is faster and cheaper, but fragile.
Feature request now that mermaid is an official part of github
facebook/docusaurus#1258
Put 5 tiles on homepage
Ability to show versions of documentation to match releases from repos
Big EULA here, do we want this? How should this show up in dev doc portal?
https://github.com/eosnetworkfoundation/eos-system-contracts/blob/main/contracts/eosio.system/ricardian/eosio.system.clauses.md
eosio.system.clauses
setup /preview path for staged content. Setup /latest for current release and stable version.
PR #52
Add front matter YAML to documents at build time. Include
Should run for install_ scripts as well
The DevRel team needs a new hostname like docs-staging or similar on the eosnetwork.com domain to run the docs build scripts. This is needed so they can inspect the docs and make sure they render correctly prior to publishing on docs.eosnetwork.com.
Requirements
and click the multi-index::modify
link
it shows 404
the link is valid (http://docs.eosnetwork.com/next/reference/mandel-cdt/group__multiindex.html#ga4b3556ef69c7faa917f185ae33a34442)
you can open it in a separate tab and it will load fine.
Seems like anchor tags are not generated for heading level 1 (#) in rendered markdown files. This also affects page navigation since first section titles/links are missing. Not sure whether filing this as a bug, enhancement, or neither. Seems like docusaurus
is adhering to the unofficial rule that 1st headings are used for page title, while 2nd/3rd+ headings used for actual section titles. If we also adhere to this, then we need to update all docs and convert # โ> ##, ## โ> ###, etc. Thoughts? @ericpassmore
for generate_documents.sh run npm run build
by default. Add -x
as suppression flag to prevent running build. Suppression of build is needed when running several generation processes back to back. You only want to run on the last build
Currently only the following directories (plus the glossary) are copied from the welcome repo when building the document portal. Need to remove these restrictions and copy over all directories.
Steps
Question: how do we remove from NavBar or does the act of swizzling remove it?
Question: does the swizzled search box have DOM structure or just behaviors? Do we need HTML/CSS styling
Swizzling will also allow you to replace search box with other options like algolia if you like
Appears to be broken, need to investigate
cleos/how-to-guides/how-to-create-an-account
We need support for these custom markups below:
[[info | Implementation location]]
[[warning | Implementation location]]
[[caution | Implementation location]]
[[danger | Implementation location]]
When they are present in an md file the text should render differently (color and background) for each of them.
Need to scope work covering the content in references
investigate best way to automatically create index.md files if they do not exit.
Attempting to create page at cdt/latest/features/return_values_from_actions, but a page already exists at this route.
Out of space need to add new s3 bucket to AWS host
use a configuration file to set the host:port for testing.
Needed to align repo PR and release with documentation update. Going forward github scripts will generate and pull docs on a new release. github scripts work on a repository level so code must align to repos
Need AWS host with 4GB min 8GB would be good for future proofing.
There are links that lead back to the b1 docs: http://docs.eosnetwork.com/next/eosdocs/client-side/jsdocs/
I see these are coming from https://github.com/eosnetworkfoundation/mandel-eosjs
Looks like we need to go through the readmes and make sure there's no links to b1 docs either
Also, the fact that the links are cyclical is strange (readme leading to docs which lead to readme)
Consider using https://www.algolia.com/
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.