Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 118 sidebar nav not showing links #433

Draft
wants to merge 2 commits into
base: v13-branch
Choose a base branch
from

Conversation

mikelittle
Copy link
Contributor

I think the fix to this is to rename the root README.md file to be something other than that name.
I also spotted that empty title attribute in the front matter is rendered as 'null'.

Remove empty title front matter.
Rename root readme to welcome
@mikelittle mikelittle changed the base branch from master to v13-branch October 18, 2022 16:51
Copy link
Contributor

@roborourke roborourke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would do it! I'll double check on renaming the README.md files for the docs site. Guessing things are ok still when it renders in the WP admin?

@roborourke
Copy link
Contributor

Ah, tests may need updating if this changes how the admin area docs render.

@mikelittle
Copy link
Contributor Author

That would do it! I'll double check on renaming the README.md files for the docs site. Guessing things are ok still when it renders in the WP admin?

Yes. It still renders fine in the dashboard.

@mikelittle
Copy link
Contributor Author

That would do it! I'll double check on renaming the README.md files for the docs site. Guessing things are ok still when it renders in the WP admin?

Yes. It still renders fine in the dashboard.

Actually, it didn't render properly in the dashboard, That's what the Travis error was.

@mikelittle mikelittle marked this pull request as draft October 20, 2022 13:59
@roborourke
Copy link
Contributor

Ah, I suspected that would be the case. I think this may need some custom handling on the docs site generation, perhaps with a special YAML frontmatter flag to mark something as top level. We have a special exceptions here to add the guides and welcome section for the dev docs: https://github.com/humanmade/altis-dev-docs-site/blob/main/src/config.docs.js#L4-L8

Maybe we can take a similar approach and change the config to achieve what we want e.g.

  • change the top level README.md to welcome.md
const REPOS = [
	{
		name: 'humanmade/altis-documentation',
		docsPath: 'user-docs',
		// mainBranch: 'master', // optional.
	},
	{
		name: 'humanmade/altis-documentation',
		docsPath: 'user-docs/administration',
		urlPrefix: '/administration'
	},
	//... etc...
];

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants